Skip to content

Commit 97eb4b9

Browse files
committed
Add usage information
1 parent 995d8f3 commit 97eb4b9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,26 @@ Certain build environments like the [Open Build Service](https://build.opensuse.
44
* it reads NPM published tarballs and presents them on a localhost interface
55
* it runs `npm install`
66

7+
- [Installation](#installation)
8+
- [From Release](#from-release)
9+
- [From Git](#from-git)
10+
- [Usage](#usage)
11+
12+
# Installation
13+
14+
## From Release
15+
`npm install --production`
16+
17+
## From Git
18+
`npm install`
19+
`npm run build`
20+
21+
At this point the application is in `dist/` and can be used as from a tagged released version
22+
23+
# Usage
24+
25+
From the directory of an application where you want to run `npm install`,
26+
27+
NPM_TGZ=list of all NPM tgz tarballs or directory containing them
28+
node ${path_to_this_app}/dist ${NPM_TGZ} ${npm install parameters}
29+

0 commit comments

Comments
 (0)