diff --git a/.all-contributorsrc b/.all-contributorsrc index 9b4c5fd..5287317 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,6 +1,7 @@ { "projectOwner": "jfmengels" , "projectName": "all-contributors-cli" +, "imageSize": 100 , "contributors": [ { "login": "jfmengels" diff --git a/README.md b/README.md index 8505bb5..6c4de30 100644 --- a/README.md +++ b/README.md @@ -8,58 +8,28 @@ This is a tool to help automate adding contributor acknowledgements according to You can install it via `npm`: ```console -npm install all-contributors-cli +npm install all-contributors-cli -g +``` +Then init the project using `init` and answering a few questions: +```console +all-contributors init +``` +Once initialized, you don't need to have `all-contributors-cli` instaled globally. You can instead save it as a devDependency of your project and add it to your scripts: +```console +npm install --save-dev all-contributors-cli ``` - -## Configuration - -### Create a `.all-contributorsrc` file - -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. - ```json { - "files": ["README.md"], - "owner": "jfmengels", - "types": { - "cheerful": { - "symbol": ":smiley:" - } - }, - "contributors": [{ - "login": "jfmengels", - "...": "..." - }] + "scripts": { + "add": "all-contributors add", + "generate": "all-contributors generate" + } } ``` - -These are the keys you can specify: -- `files`: Array of files to update. Default: `['README.md']` -- `projectOwner`: Name of the user the project is hosted by. Example: `jfmengels/all-contributor-cli` --> `jfmengels`. Mandatory. -- `projectName`: Name of the project. Example: `jfmengels/all-contributor-cli` --> `all-contributor-cli`. Mandatory. -- `types`: Specify custom symbols or link templates for contribution types. Can override the documented types. -- `imageSize`: Size (in px) of the user's avatar. Default: `100`. -- `contributorsPerLine`: Maximum number of columns for the contributors table. Default: `7`. -- `contributorTemplate`: Define your own template to generate the contributor 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. - -```md -## Contributors - - - -``` - -If you wish to add a badge ( [![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors) ) indicating the number of collaborators, add the following comment tags section: - -```md -some-badge - -some-other-badge +and use them via `npm run`: +```console +npm run add -- jfmengels doc +npm run generate ``` ## Usage @@ -72,9 +42,9 @@ Use `generate` to generate the contributors list and inject it into your contrib all-contributors generate ``` -### Add new contributor +### Add/update contributors -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. +Use `add` to add new contributors to your project, or add new ways in which they contributed. They will be added to your configuration file. The contributors file will then be updated just as if you used the `generate` command. ```console # Add new contributor , who made a contribution of type @@ -82,10 +52,7 @@ all-contributors add # 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)): +Where `username` is the user's GitHub username, and `contribution` is a `,`-separated list of ways to contribute, from the following list ([see the specs](https://github.com/kentcdodds/all-contributors#emoji-key)): - code: πŸ’» - plugin: πŸ”Œ - tool: πŸ”§ @@ -102,13 +69,26 @@ Where: - design: 🎨 - review: πŸ‘€ +## Configuration + +You can configure the project by updating the `.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. + +These are the keys you can specify: +- `files`: Array of files to update. Default: `['README.md']` +- `projectOwner`: Name of the user the project is hosted by. Example: `jfmengels/all-contributor-cli` --> `jfmengels`. Mandatory. +- `projectName`: Name of the project. Example: `jfmengels/all-contributor-cli` --> `all-contributor-cli`. Mandatory. +- `types`: Specify custom symbols or link templates for contribution types. Can override the documented types. +- `imageSize`: Size (in px) of the user's avatar. Default: `100`. +- `contributorsPerLine`: Maximum number of columns for the contributors table. Default: `7`. +- `contributorTemplate`: Define your own template to generate the contributor list. +- `badgeTemplate`: Define your own template to generate the badge. ## Contributors Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): -| [![Jeroen Engels](https://avatars.githubusercontent.com/u/3869412?v=3&s=undefined)
Jeroen Engels](https://github.com/jfmengels)
[πŸ’»](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels) [πŸ“–](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels) [⚠️](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels) | [![Kent C. Dodds](https://avatars.githubusercontent.com/u/1500684?v=3&s=undefined)
Kent C. Dodds](http://kentcdodds.com/)
[πŸ“–](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds) | +| [![Jeroen Engels](https://avatars.githubusercontent.com/u/3869412?v=3&s=100)
Jeroen Engels](https://github.com/jfmengels)
[πŸ’»](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels) [πŸ“–](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels) [⚠️](https://github.com/jfmengels/all-contributors-cli/commits?author=jfmengels) | [![Kent C. Dodds](https://avatars.githubusercontent.com/u/1500684?v=3&s=100)
Kent C. Dodds](http://kentcdodds.com/)
[πŸ“–](https://github.com/jfmengels/all-contributors-cli/commits?author=kentcdodds) | | :---: | :---: |