Skip to content

Commit

Permalink
Merge pull request #74 from bcgov/update_docs
Browse files Browse the repository at this point in the history
Adding bcgov prefix to smk-cli in docs
  • Loading branch information
michaelpnelson authored Sep 15, 2021
2 parents d1c34c5 + 95a7f92 commit 1cae31c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

NPM should now install all required packages as a globally accessible command line utility. You're ready to get started!
Expand Down

0 comments on commit 1cae31c

Please sign in to comment.