From d03152b0a946d31e3a6f1898dc3460e2bf7fb50b Mon Sep 17 00:00:00 2001 From: Michael Nelson Date: Wed, 15 Sep 2021 13:38:19 -0700 Subject: [PATCH 1/2] Adding bcgov prefix to smk-cli in docs --- docs/getting-started.md | 4 ++-- docs/installation.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 203ec74..173ca9c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -5,9 +5,9 @@ Firstly, lets get acquainted with SMK and the SMK-CLI. Some useful links for various components of the SMK Project - [SMK repo](https://github.com/bcgov/smk) -- [SMK NPM repo](https://www.npmjs.com/package/smk) +- [SMK NPM repo](https://www.npmjs.com/package/@bcgov/smk) - [SMK-CLI repo](https://github.com/bcgov/smk-cli) -- [SMK-CLI NPM repo](https://www.npmjs.com/package/smk-cli) +- [SMK-CLI NPM repo](https://www.npmjs.com/package/@bcgov/smk-cli) Please review the SMK documentation prior to using the SMK-CLI. All SMK repositories are currently hosted on GitHub and are completely open-source. diff --git a/docs/installation.md b/docs/installation.md index 525dc86..69af9b7 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -5,15 +5,15 @@ Once you have Node.js and NPM installed on your machine you're ready to download and install the SMK-CLI. Simply type the following into your command line of choice: ```bash -npm install —global smk-cli +npm install —global @bcgov/smk-cli ``` -If you prefer to install a specific version, you can check NPM for the available version list in the [NPM repository](https://www.npmjs.com/package/smk-cli/) +If you prefer to install a specific version, you can check NPM for the available version list in the [NPM repository](https://www.npmjs.com/package/@bcgov/smk-cli) then append the version tag on your install command: ```bash -npm install —global smk-cli@1.0.0-beta.6 +npm install —global @bcgov/smk-cli@1.0.0-beta.6 ``` NPM should now install all required packages as a globally accessible command line utility. You're ready to get started! From 95a7f922c691ff93064d5c291d1f3e73872b1f3b Mon Sep 17 00:00:00 2001 From: Michael Nelson Date: Wed, 15 Sep 2021 13:50:40 -0700 Subject: [PATCH 2/2] Removed beta from npm install cmd in docs --- docs/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation.md b/docs/installation.md index 69af9b7..ff99992 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -13,7 +13,7 @@ If you prefer to install a specific version, you can check NPM for the available then append the version tag on your install command: ```bash -npm install —global @bcgov/smk-cli@1.0.0-beta.6 +npm install —global @bcgov/smk-cli ``` NPM should now install all required packages as a globally accessible command line utility. You're ready to get started!