From d6c71bdb9776bbcf23b59b95bee5f546cfd42f81 Mon Sep 17 00:00:00 2001
From: Fabian Affolter <fabian@affolter-engineering.ch>
Date: Wed, 19 Apr 2017 07:51:09 +0200
Subject: [PATCH] Add README for the generator

---
 credits_generator/README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 credits_generator/README.md

diff --git a/credits_generator/README.md b/credits_generator/README.md
new file mode 100644
index 00000000000..03c187d2d8a
--- /dev/null
+++ b/credits_generator/README.md
@@ -0,0 +1,29 @@
+credits_generator
+=================
+
+This tool can be used to update the [Home Assistant's Credits page](https://home-assistant.io/developers/credits/).
+
+```bash
+$ cd credits_generator
+$ npm install
+```
+
+Set your personal GitHub access token as environmental variable.
+
+```bash
+$ export GITHUB_TOKEN=<Your GitHub access token>
+```
+
+Run the script.
+
+```bash
+$ node update_credits.js
+```
+
+Commit the changes (depending on our setup).
+
+```bash
+$ git commit ../source/developers/credits.markdown
+$ git push upstream
+```
+