This is a tool to help automate adding contributor acknowledgements according to the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
You must create a `.all-contributorsrc` JSON file. The data used to generate the contributors list will be stored in here, and you can configure how you want `all-contributors-cli` to generate the list.
-`badgeTemplate`: Define your own template to generate the badge.
### Add contributors section
If you don't already have a Contributors section in a Markdown file, create one. Then add the comment tags section below to it. Don't worry, they're visible only to those that read the raw file. The tags **must** be at the beginning of the line, and each on their separate line.
```md
## Contributors
<!-- CONTRIBUTORS:START - Do not remove or modify this section -->
<!-- CONTRIBUTORS:END -->
```
If you wish to add a badge ( [](#contributors) ) indicating the number of collaborators, add the following tags (again, at the beginning of the line and each on their separate line):
```md
some-badge
<!-- CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
Use `generate` to generate the contributors list and inject it into your contributors file. Contributors will be read from your configuration file.
```
all-contributors generate
```
### Add new contributor
Use `add` to add new contributors to your project. They will be added to your configuration file. The contributors file will then be updated just as if you used the `generate` command.
```
# Add new contributor <username>, who made a contribution of type <contribution>
all-contributors add <username><contribution>
# Example:
all-contributors add jfmengels code,doc
```
Where:
-`username` is the user's GitHub username
-`contribution` is a `,`-separated list of ways to contribute, from the following list ([see the specs](https://github.com/kentcdodds/all-contributors#emoji-key)):
