From 46bc072166561c39292f2b8131fb41ec823dfacf Mon Sep 17 00:00:00 2001
From: Jeroen Engels <jfm.engels@gmail.com>
Date: Mon, 29 Feb 2016 09:21:34 +0100
Subject: [PATCH] Add info to README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index dd9dbfa..bfa7fb4 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,43 @@ This is a tool to help automate adding contributor acknowledgements according to
 
 ## Usage
 
-TODO
+```
+all-contributors <username> <contribution>
+```
+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: 🎨
 
 ## Configuration
 
-TODO
+You can configure the project by creating a `.all-contributors` JSON file.
+
+```json
+{
+  "file": "README.md",
+  "owner": "jfmengels",
+  "emoji": {
+    "thoughtleadering": "some emoji"
+  }
+}
+```
+
+These are the keys you can specify:
+- TODO `file`: File to write the list of contributors in. Default: 'README.md'
+- TODO `owner`: Name of the user the project is hosted by. Example: `jfmengels/all-contributor-cli` --> `jfmengels`. By default will be parsed from the repo's homepage in `package.json`.
+- TODO `project`: Name of the project. Default: Name of the project written in the `package.json` file.
+- TODO `imageSize`: Size (in px) of the user's avatar. Default: 100.
+- TODO `emoji`: Specify custom emoji, can override the existing override.