Skip to content

Commit c2a962d

Browse files
author
Eugen Kuksa
committed
📝 add installation instructions
1 parent 808dce7 commit c2a962d

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

Readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ It is based on the following third party packages
1919

2020
# Installation
2121

22+
## Configure NPM Registry Access
23+
Make sure you can install packages from Github's NPM registry. See [how to use it the official documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package) for details.
24+
TL;DR: If your personal Github access token with `read:packages` scope is `$GITHUB_NPM_TOKEN`, you can authenticate npm by running
25+
```bash
26+
echo "@openreplyde:registry=https://npm.pkg.github.com
27+
//npm.pkg.github.com/:_authToken=${GITHUB_NPM_TOKEN}
28+
" >> ~/.npmrc
29+
```
30+
You only need to do the above once on your machine.
31+
32+
## Install and Use the Package
33+
2234
Install the package with
2335

2436
```bash

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"repository": {
44
"url": "https://github.com/OpenReplyDE/nestjs-express-openapi"
55
},
6-
"version": "0.1.0",
6+
"version": "0.1.1",
77
"description": "OpenAPI to NestJS Code Generator and Type Helpers",
88
"license": "MIT",
99
"main": "dist/index.cjs",

0 commit comments

Comments
 (0)