From ea2fe6eece471bef632815e95aa608d5d399bba6 Mon Sep 17 00:00:00 2001 From: c4605 Date: Tue, 6 Aug 2024 00:07:54 +0100 Subject: [PATCH] docs: add more details on how to install the privately published package --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6970817..4191418 100644 --- a/README.md +++ b/README.md @@ -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` \ No newline at end of file