Skip to content

Commit

Permalink
README changes - round 3
Browse files Browse the repository at this point in the history
  • Loading branch information
mster committed Mar 7, 2019
1 parent 3e797fc commit e7f960c
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions README.md
@@ -1,6 +1,6 @@
# NCM-CLI

`ncm-cli` is a command-line tool for [NodeSource Certified Modules 2.0](), designed to make code quality, security, and compliance a breeze. Generate a custom project report, fetch compliance and security information, manage organizational whitelists, and inspect specific packages in greater detail -- all from the command-line.
`ncm-cli` is a command-line tool for NodeSource Certified Modules 2.0, designed to make code quality, security, and compliance a breeze. Generate a custom project report, fetch compliance and security information, manage organizational whitelists, and inspect specific packages in greater detail -- all from the command-line.

## Installation

Expand Down Expand Up @@ -37,23 +37,12 @@ ncm signin (interactive)
ncm signout
```

### Exiting
`ncm-cli` is designed to exit non-zero in the event of certification failures.

```
$ ncm report
...
$ echo $?
1
```


## Authentication

`ncm-cli` supports three forms of authentication.

### 1. Accounts:
Sign-in interactively using your [accounts.nodesource](https://accounts.nodesource.com) email and password.
### 1. NodeSource Account:
Sign-in interactively using your [NodeSource account](https://accounts.nodesource.com) email and password.

```
$ ncm signin
Expand Down

0 comments on commit e7f960c

Please sign in to comment.