From a82c7cbf71c5bc7bcfe7970224077eadd36226ef Mon Sep 17 00:00:00 2001 From: Okinea Dev <81070564+okineadev@users.noreply.github.com> Date: Sun, 22 Sep 2024 16:45:30 +0300 Subject: [PATCH] docs: Improved docs and links (#970) Co-authored-by: Aaron --- CONTRIBUTING.md | 4 ++-- README.md | 32 +++++++++++++++++++++++++------- packages/wxt/README.md | 35 +++++++++++++++++++++++++++-------- scripts/generate-readmes.sh | 9 +++++++++ 4 files changed, 63 insertions(+), 17 deletions(-) create mode 100755 scripts/generate-readmes.sh diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58eb4541..fbe6fdc3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Everyone is welcome to contribute to WXT! +Everyone is welcome to contribute to **WXT**! If you are changing the docs or fixing a bug, feel free to fork and open a PR. @@ -139,7 +139,7 @@ Releases are done with GitHub actions: Use [`taze`](https://www.npmjs.com/package/taze) to upgrade dependencies throughout the entire monorepo. -```ts +```sh pnpm dlx taze -r ``` diff --git a/README.md b/README.md index 5daaef45..3808327c 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@

- WXT Logo + WXT Logo WXT

- npm + npm version - npm + downloads - NPM + license | MIT - Codecov + coverage

@@ -43,10 +43,21 @@ https://github.com/wxt-dev/wxt/assets/10101283/4d678939-1bdb-495c-9c36-3aa281d84 Bootstrap a new project: + + ```sh -pnpm dlx wxt@latest init +# npm +npx wxt@latest init + +# pnpm +pnpm dlx wxt@latest init + +# bun +bunx wxt@latest init ``` + + Or see the [installation guide](https://wxt.dev/guide/installation.html) to get started with WXT. ## Features @@ -66,6 +77,13 @@ Or see the [installation guide](https://wxt.dev/guide/installation.html) to get ## Contributors + + +Published under the [MIT](https://github.com/wxt-dev/wxt/blob/main/LICENSE) license. +Made by [@aklinker1](https://github.com/aklinker1) and [community](https://github.com/wxt-dev/wxt/graphs/contributors) 💛 +

- + + + diff --git a/packages/wxt/README.md b/packages/wxt/README.md index a34a8f8e..f629dbd0 100644 --- a/packages/wxt/README.md +++ b/packages/wxt/README.md @@ -1,16 +1,17 @@ +

- WXT Logo + WXT Logo WXT

- npm + npm version - npm + downloads - NPM + license | MIT - Codecov + coverage

@@ -18,7 +19,7 @@
âš¡
- It's like Nuxt, but for Chrome Extensions + It's like Nuxt, but for Web Extensions

@@ -43,10 +44,21 @@ https://github.com/wxt-dev/wxt/assets/10101283/4d678939-1bdb-495c-9c36-3aa281d84 Bootstrap a new project: + + ```sh -pnpm dlx wxt@latest init +# npm +npx wxt@latest init + +# pnpm +pnpm dlx wxt@latest init + +# bun +bunx wxt@latest init ``` + + Or see the [installation guide](https://wxt.dev/guide/installation.html) to get started with WXT. ## Features @@ -66,6 +78,13 @@ Or see the [installation guide](https://wxt.dev/guide/installation.html) to get ## Contributors + + +Published under the [MIT](https://github.com/wxt-dev/wxt/blob/main/LICENSE) license. +Made by [@aklinker1](https://github.com/aklinker1) and [community](https://github.com/wxt-dev/wxt/graphs/contributors) 💛 +

- + + + diff --git a/scripts/generate-readmes.sh b/scripts/generate-readmes.sh new file mode 100755 index 00000000..fc8b4f1e --- /dev/null +++ b/scripts/generate-readmes.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +# +# Generate code in README.md and sync it with wxt/packages/README.md for NPM +# + +pnpm dlx automd +echo "" > packages/wxt/README.md +cat README.md >> packages/wxt/README.md