Skip to content

Commit

Permalink
docs: improve installation instructions after new package published to
Browse files Browse the repository at this point in the history
NPM
  • Loading branch information
mikaello committed Apr 24, 2021
1 parent 25626e1 commit 3d9ce91
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,16 @@ This project originates from [ept/avrodoc](https://github.com/ept/avrodoc) -> [c
## Usage

```bash
npm install --global mikaello/avrodoc-plus#v1 | yarn add global mikaello/avrodoc-plus#v1
npm install --global @mikaello/avrodoc-plus | yarn add global @mikaello/avrodoc-plus
avrodoc-plus -i source -o out.html
```

Or without installation:

```bash
npx @mikaello/avrodoc-plus -i source -o out.html
```

### Options

- -i _sourcefolder_
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"type": "module",
"bin": "./bin/avrodoc-plus.js",
"scripts": {
"start": "node src/cli",
"server": "node app",
"start": "node src/cli.js",
"server": "node app.js",
"test": "NODE_OPTIONS=--experimental-vm-modules jest src/"
},
"dependencies": {
Expand Down

0 comments on commit 3d9ce91

Please sign in to comment.