imrpoved readme

oscklm · Jan 9, 2024 · 88ee0e4 · 88ee0e4
1 parent 002bcc2
commit 88ee0e4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/.changeset/big-meals-kneel.md b/.changeset/big-meals-kneel.md
@@ -0,0 +1,5 @@
+---
+"package-stack-example": patch
+---
+
+improved readme and added valuable learnings
diff --git a/README.md b/README.md
@@ -4,3 +4,11 @@ A simple and neat setup for a NPM Package
 
 **Credit where credit is due:**
 [Blazing Fast Tips: Publishing to NPM](https://www.youtube.com/watch?v=eh89VE3Mk5g)
+
+## Learnings
+
+- Make sure PR permissions is properly set up for actions in github settings
+- `.npmrc` with `autoInstallPeers=true` set to true was necessary for pnpm install --frozen-lockfile to run
+- `secrets.NPM_TOKEN` setup required for publish workflow to run
+- Make sure `"access": "public" on publishConfig` is added
+- If 2FA is setup on NPM account account in NPM, that you disable it for write actions