From 932fe56a048127abf9b7e5a166a1941897e6bce7 Mon Sep 17 00:00:00 2001 From: Jeromy Cannon Date: Sun, 19 Nov 2023 20:32:20 -0600 Subject: [PATCH] docs: update CLI installation instruction in README (#563) Signed-off-by: Lenin Mehedy --- .remarkrc.yml | 8 ++++++++ fullstack-network-manager/.remarkrc.yml | 8 ++++++++ fullstack-network-manager/README.md | 8 +++++--- fullstack-network-manager/package.json | 7 ------- 4 files changed, 21 insertions(+), 10 deletions(-) create mode 100644 .remarkrc.yml create mode 100644 fullstack-network-manager/.remarkrc.yml diff --git a/.remarkrc.yml b/.remarkrc.yml new file mode 100644 index 000000000..737365955 --- /dev/null +++ b/.remarkrc.yml @@ -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 diff --git a/fullstack-network-manager/.remarkrc.yml b/fullstack-network-manager/.remarkrc.yml new file mode 100644 index 000000000..737365955 --- /dev/null +++ b/fullstack-network-manager/.remarkrc.yml @@ -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 diff --git a/fullstack-network-manager/README.md b/fullstack-network-manager/README.md index 2a0a5759b..074283a4f 100644 --- a/fullstack-network-manager/README.md +++ b/fullstack-network-manager/README.md @@ -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 diff --git a/fullstack-network-manager/package.json b/fullstack-network-manager/package.json index 6796cd07a..0003b91a9 100644 --- a/fullstack-network-manager/package.json +++ b/fullstack-network-manager/package.json @@ -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"] - ] } }