From 6c541894ab2bd68ef3e1862c034d27a448448c14 Mon Sep 17 00:00:00 2001
From: Kevin Schoon <kevinschoon@gmail.com>
Date: Sat, 3 Feb 2018 13:50:03 -0500
Subject: [PATCH] update readme

---
 README.md       | 23 +++++++++++++++++++++--
 docs/index.html | 22 ++++++++++++++++++++--
 2 files changed, 41 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 374704d..229d9c3 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ The Pomodoro Technique is simple and effective:
 
 ### Binaries
 
-Binaries are available for Linux and Darwin platforms in the [releases section](https://github.com/kevinschoon/pomo/releases) on github.
+Binaries are available for Linux and OSX platforms in the [releases section](https://github.com/kevinschoon/pomo/releases) on github.
 
 #### Linux
 
@@ -31,7 +31,7 @@ chmod +x pomo
 # Copy pomo to somewhere on your $PATH
 ```
 
-#### Darwin
+#### OSX
 
 ```
 curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-darwin-amd64
@@ -63,6 +63,25 @@ Start a 4 pomodoro session at 25 minute intervals:
 pomo start -t my-project "write some codes"
 ```
 
+## Configuration
+
+Pomo has a few configuration options which can be read from a JSON file in Pomo's state directory `~/.pomo/config.json`.
+
+### colors
+
+You can map colors to specific tags in the `colors` field.
+
+Example:
+```
+{
+    "colors": {
+        "my-project": "hiyellow",
+        "another-project": "green"
+    }
+}
+```
+
+
 ## Roadmap
 
   * Generate charts/burn down
diff --git a/docs/index.html b/docs/index.html
index 48791b1..43a05ba 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -144,7 +144,7 @@
 
 <h3 id="binaries">Binaries</h3>
 
-<p>Binaries are available for Linux and Darwin platforms in the <a href="https://github.com/kevinschoon/pomo/releases">releases section</a> on github.</p>
+<p>Binaries are available for Linux and OSX platforms in the <a href="https://github.com/kevinschoon/pomo/releases">releases section</a> on github.</p>
 
 <h4 id="linux">Linux</h4>
 
@@ -156,7 +156,7 @@ chmod +x pomo
 # Copy pomo to somewhere on your $PATH
 </code></pre>
 
-<h4 id="darwin">Darwin</h4>
+<h4 id="osx">OSX</h4>
 
 <pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-darwin-amd64
 # Optionally verify file integrity
@@ -185,6 +185,24 @@ chmod +x pomo
 <pre><code>pomo start -t my-project &quot;write some codes&quot;
 </code></pre>
 
+<h2 id="configuration">Configuration</h2>
+
+<p>Pomo has a few configuration options which can be read from a JSON file in Pomo&rsquo;s state directory <code>~/.pomo/config.json</code>.</p>
+
+<h3 id="colors">colors</h3>
+
+<p>You can map colors to specific tags in the <code>colors</code> field.</p>
+
+<p>Example:</p>
+
+<pre><code>{
+    &quot;colors&quot;: {
+        &quot;my-project&quot;: &quot;hiyellow&quot;,
+        &quot;another-project&quot;: &quot;green&quot;
+    }
+}
+</code></pre>
+
 <h2 id="roadmap">Roadmap</h2>
 
 <ul>