docs: add authentication guide

bkalendar · Oct 28, 2023 · 631e970 · 631e970
1 parent c6920b4
commit 631e970
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+# Contributing Guides
+
+## Unauthorized error when downloading `@bkalendar/core`
+
+To solve this issue, you need to be _authenticated_ to even read and download
+packages from the GitHub NPM Registry.
+
+1. Head over to https://github.com/settings/tokens, create a token with
+   only permission `read:packages`.
+2. Run this command:
+
+   ```console
+   $ npm login --registry=https://npm.pkg.github.com
+   ```
+
+3. Login with:
+
+   - Username: Your GitHub username
+   - Password: The token you created above
+
+`pnpm install` should now work fine.