kylefang/bro-sdk
1
0
Fork 0
mirror of https://github.com/Brotocol-xyz/bro-sdk.git synced 2026-01-12 14:54:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add more details on how to install the privately published package

Browse Source
This commit is contained in:
c4605
2024-08-06 00:07:54 +01:00
parent ee3a83659b
commit ea2fe6eece
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -1,10 +1,13 @@
# xlink-sdk
## How to install the privately published package
## How to install the privately published package from GitHub Package Registry
1. [Authenticating to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages)
2. Add a `.npmrc' file to the project that needs to install this package
1. Follow the guide [Authenticating to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages) to create a personal access token
2. Add a `.npmrc` file to the project that needs to install this package (the `GITHUB_NPM_KEY' is an environment variable, which is the personal access token created in the previous step)
```
@xlink-network:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_NPM_KEY}
```
3. Run `npm install`