Copy readme to root folder (#92)

* Revert "Add readme to npm (#90)" This reverts commit bd5ef96. * Expose readme on publishing NPM package
powerhome · Jan 31, 2023 · 882e057 · 882e057
1 parent b00c30b
commit 882e057
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/.github/workflows/eslint-config.yml b/.github/workflows/eslint-config.yml
@@ -41,6 +41,8 @@ jobs:
           registry-url: ${{ env.REGISTRY_URL }}
       - run: yarn install --frozen-lockfile
         working-directory: ${{ env.PROJECT_DIR }}
+      - run: yarn expose-readme
+        working-directory: ${{ env.PROJECT_DIR }}
       - run: yarn publish
         working-directory: ${{ env.PROJECT_DIR }}
         env:

diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -19,7 +19,8 @@
   "scripts": {
     "lint": "eslint lib/*",
     "prettier": "prettier -c --config ./lib/prettier.js .",
-    "prettier:write": "prettier --write --config ./lib/prettier.js ."
+    "prettier:write": "prettier --write --config ./lib/prettier.js .",
+    "expose-readme": "cp docs/README.md ."
   },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": "5.47.0",