Skip to content

Commit b6e63fa

Browse files
authored
chore: Updated README install instructions (#16)
1 parent b76e7a7 commit b6e63fa

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,21 @@
1919

2020
`tools/ci/deploy/deploy.ts` handles asynchronous+simultaneous deployments to a group of beanstalk environments. It does this by creating an Application Version (one per Beanstalk Application only) from an artifact in S3 followed by issuing deployments of that Application Version to each respective beanstalk environment in the group.
2121

22-
### Installation
22+
The library can be pulled from GitHub Packages.
23+
24+
### Authentication
25+
26+
> ***TL;DR:*** Follow the [abridged instructions](https://github.com/time-loop/cdk-library#setup-github-packages-access) written in cdk-library.
2327
24-
To install the package in a project (especially locally), you'll first need to setup a GitHub PAT since this package is hosted in GitHub Packages. General instructions to do so can be [found here](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
28+
You need to setup scoped access to GitHub Packages in your `~/.npmrc`. To do so, create a GitHub PAT with scope `read:packages`. With such a limited scope, setting expiry to `never` is permissible. Canonical instructions to do this can be [found here](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
2529

26-
> ***NOTE:*** If you are working with a GitHub Workflow, the provided `GITHUB_TOKEN` might Just Work for you as this is a public package. However, if you also need to access packages that are private to your org, you might consider adding an `ALL_PACKAGE_READ_TOKEN` org secret followed by populating your .npmrc appropriately.
30+
> NOTE: If you are working with a GitHub Workflow, the provided `GITHUB_TOKEN` might Just Work for you as this is a public package. However, if you also need to access packages that are private to your org, you might consider adding an `ALL_PACKAGE_READ_TOKEN` org secret followed by populating your .npmrc appropriately.
2731
28-
Once created with at least `read:package` and `repo` access, in your project follow these steps under [Installing a Package](https://itnext.io/setting-up-github-packages-for-npm-2bc9f8e4b11e) where `@yourcompany` is `@time-loop`.
32+
After creating a PAT, follow [canonical instructions to setup your authentication to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry).
33+
34+
### Installation
2935

30-
Then, install with `npm` in your project like so:
36+
Use `npm` or any relevant package manager in your project like so:
3137

3238
```bash
3339
# --save-dev is optional, depending on whether this is used in the main app or

0 commit comments

Comments
 (0)