When publishing a package, copy README from root folder.

molefrog · Feb 26, 2024 · f36fa22 · f36fa22
1 parent 8971676
commit f36fa22
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -25,3 +25,7 @@ tsconfig.vitest-temp.json
 # type definitions in the project root are copied from types/ folder
 # before publishing, so they should be ignored
 /*.d.ts
+
+# README is copied from the root folder
+packages/wouter/README.md
+packages/wouter-preact/README.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -17,7 +17,10 @@
     "lint-types": "vitest typecheck"
   },
   "author": "Alexey Taktarov <molefrog@gmail.com>",
-  "repository": "molefrog/wouter",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/molefrog/wouter.git"
+  },
   "license": "ISC",
   "prettier": {
     "tabWidth": 2,

diff --git a/packages/wouter-preact/package.json b/packages/wouter-preact/package.json
@@ -54,10 +54,14 @@
   },
   "scripts": {
     "build": "rollup -c",
-    "watch": "rollup -c -w"
+    "watch": "rollup -c -w",
+    "prepublishOnly": "npm run build && cp ../../README.md ."
   },
   "author": "Alexey Taktarov <molefrog@gmail.com>",
-  "repository": "molefrog/wouter",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/molefrog/wouter.git"
+  },
   "license": "Unlicense",
   "peerDependencies": {
     "preact": "^10.0.0"

diff --git a/packages/wouter/package.json b/packages/wouter/package.json
@@ -54,7 +54,8 @@
   },
   "scripts": {
     "build": "rollup -c",
-    "watch": "rollup -c -w"
+    "watch": "rollup -c -w",
+    "prepublishOnly": "npm run build && cp ../../README.md ."
   },
   "author": "Alexey Taktarov <molefrog@gmail.com>",
   "repository": {