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 @@
@@ -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
@@ -18,7 +19,7 @@
@@ -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
-
+
+
+
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
âš¡
- It's like Nuxt, but for Chrome Extensions
+ It's like Nuxt, but for Web Extensions
-
+
+
+
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