mirror of
https://github.com/all-contributors/cli.git
synced 2025-01-10 05:56:29 +00:00
Add installation command in README
This commit is contained in:
parent
7af2cb7dec
commit
05a6b41b03
1 changed files with 8 additions and 1 deletions
|
@ -2,10 +2,17 @@
|
||||||
|
|
||||||
This is a tool to help automate adding contributor acknowledgements according to the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
|
This is a tool to help automate adding contributor acknowledgements according to the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
You can install it via `npm`:
|
||||||
|
```
|
||||||
|
npm install all-contributors-cli
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
# Add new contributor <username>, who a contribution of type <contribution>
|
# Add new contributor <username>, who made a contribution of type <contribution>
|
||||||
all-contributors add <username> <contribution>
|
all-contributors add <username> <contribution>
|
||||||
# Example:
|
# Example:
|
||||||
all-contributors add jfmengels code,doc
|
all-contributors add jfmengels code,doc
|
||||||
|
|
Loading…
Reference in a new issue