From 5949ac389b9efe3b5482f08a05f80ba15d7a5bb1 Mon Sep 17 00:00:00 2001 From: Jeroen Engels Date: Wed, 2 Mar 2016 23:50:50 +0100 Subject: [PATCH] Add kentcdodds to contributors --- .all-contributorsrc | 39 ++++++++++++++++--------- README.md | 70 +++++++++++++++++++++++++++------------------ 2 files changed, 67 insertions(+), 42 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index b41c567..51e01a6 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,16 +1,27 @@ { - "projectOwner": "jfmengels", - "projectName": "all-contributors-cli", - "imageSize": 100, - "contributors": [{ - "login": "jfmengels", - "name": "Jeroen Engels", - "avatar_url": "https://avatars.githubusercontent.com/u/3869412?v=3", - "html_url": "https://github.com/jfmengels", - "contributions": [ - "code", - "doc", - "test" - ] - }] + "projectOwner": "jfmengels" +, "projectName": "all-contributors-cli" +, "imageSize": 100 +, "contributors": [ + { + "login": "jfmengels" + , "name": "Jeroen Engels" + , "avatar_url": "https://avatars.githubusercontent.com/u/3869412?v=3" + , "html_url": "https://github.com/jfmengels" + , "contributions": [ + "code" + , "doc" + , "test" + ] + } + , { + "login": "kentcdodds" + , "name": "Kent C. Dodds" + , "avatar_url": "https://avatars.githubusercontent.com/u/1500684?v=3" + , "html_url": "http://kentcdodds.com/" + , "contributions": [ + "doc" + ] + } + ] } diff --git a/README.md b/README.md index 70156e7..284039a 100644 --- a/README.md +++ b/README.md @@ -9,32 +9,6 @@ You can install it via `npm`: npm install all-contributors-cli ``` -## Usage - -``` -# Add new contributor , who made a contribution of type -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)): - - code: 💻 - - plugin: 🔌 - - tool: 🔧 - - doc: 📖 - - question: ❓ - - test: ⚠️ - - bug: 🐛 - - example: 💡 - - blog: 📝 - - tutorial: ✅ - - video: 📹 - - talk: 📢 - - design: 🎨 - - review: 👀 - ## Configuration ### Add contributing section @@ -77,14 +51,54 @@ These are the keys you can specify: - `contributorsPerLine`: Maximum number of columns for the contributors table. Default: 7. - `template`: Define your own template to generate the contributor list. +## Usage + +### Generating the contributors list + +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 , who made a contribution of type +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)): + - code: 💻 + - plugin: 🔌 + - tool: 🔧 + - doc: 📖 + - question: ❓ + - test: ⚠️ + - bug: 🐛 + - example: 💡 + - blog: 📝 + - tutorial: ✅ + - translate: 🌍 + - video: 📹 + - talk: 📢 + - design: 🎨 + - review: 👀 + ## 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=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) | -| :---: | +| [![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) | +| :---: | :---: | This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.