Skip to content

Commit

Permalink
docs: update CLI installation instruction in README (#563)
Browse files Browse the repository at this point in the history
Signed-off-by: Lenin Mehedy <lenin.mehedy@swirldslabs.com>
  • Loading branch information
jeromy-cannon authored Nov 20, 2023
1 parent cd62f1f commit 932fe56
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 10 deletions.
8 changes: 8 additions & 0 deletions .remarkrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
plugins:
# Check that markdown is consistent.
- remark-preset-lint-consistent
# Few recommended rules.
- remark-preset-lint-recommended
# list item indentation should be space
- - remark-lint-list-item-indent
- space
8 changes: 8 additions & 0 deletions fullstack-network-manager/.remarkrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
plugins:
# Check that markdown is consistent.
- remark-preset-lint-consistent
# Few recommended rules.
- remark-preset-lint-recommended
# list item indentation should be space
- - remark-lint-list-item-indent
- space
8 changes: 5 additions & 3 deletions fullstack-network-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ fullstack-network-manager is a CLI tool to manage and deploy a Hedera Network us

## Install

* Create or update `~/.npmrc` file and specify the GitHub package registry: `@hashgraph:registry=https://npm.pkg.github.com`
* Create or update `~/.npmrc` file and specify the GitHub package registry:

```
❯ cat ~/.npmrc
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
@hashgraph:registry=https://npm.pkg.github.com
```

* Run `npm install -g @hedera/fullstack-network-manager`
* Get your [Github access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) and setup an environment variable GITHUB\_TOKEN.

* Run `npm install -g @hashgraph/fullstack-network-manager`

* Run `fsnetman` from a terminal as shown below

Expand Down
7 changes: 0 additions & 7 deletions fullstack-network-manager/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,5 @@
"engines": {
"node": ">=18.18.2",
"npm": ">=9.8.1"
},
"remarkConfig": {
"plugins": [
"remark-preset-lint-consistent",
"remark-preset-lint-recommended",
["remark-lint-list-item-indent", "space"]
]
}
}

0 comments on commit 932fe56

Please sign in to comment.