Commit
+41 -4 +/-2 browse
| 1 | diff --git a/README.md b/README.md |
| 2 | index 374704d..229d9c3 100644 |
| 3 | --- a/README.md |
| 4 | +++ b/README.md |
| 5 | @@ -18,7 +18,7 @@ The Pomodoro Technique is simple and effective: |
| 6 | |
| 7 | ### Binaries |
| 8 | |
| 9 | - Binaries are available for Linux and Darwin platforms in the [releases section](https://github.com/kevinschoon/pomo/releases) on github. |
| 10 | + Binaries are available for Linux and OSX platforms in the [releases section](https://github.com/kevinschoon/pomo/releases) on github. |
| 11 | |
| 12 | #### Linux |
| 13 | |
| 14 | @@ -31,7 +31,7 @@ chmod +x pomo |
| 15 | # Copy pomo to somewhere on your $PATH |
| 16 | ``` |
| 17 | |
| 18 | - #### Darwin |
| 19 | + #### OSX |
| 20 | |
| 21 | ``` |
| 22 | curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-darwin-amd64 |
| 23 | @@ -63,6 +63,25 @@ Start a 4 pomodoro session at 25 minute intervals: |
| 24 | pomo start -t my-project "write some codes" |
| 25 | ``` |
| 26 | |
| 27 | + ## Configuration |
| 28 | + |
| 29 | + Pomo has a few configuration options which can be read from a JSON file in Pomo's state directory `~/.pomo/config.json`. |
| 30 | + |
| 31 | + ### colors |
| 32 | + |
| 33 | + You can map colors to specific tags in the `colors` field. |
| 34 | + |
| 35 | + Example: |
| 36 | + ``` |
| 37 | + { |
| 38 | + "colors": { |
| 39 | + "my-project": "hiyellow", |
| 40 | + "another-project": "green" |
| 41 | + } |
| 42 | + } |
| 43 | + ``` |
| 44 | + |
| 45 | + |
| 46 | ## Roadmap |
| 47 | |
| 48 | * Generate charts/burn down |
| 49 | diff --git a/docs/index.html b/docs/index.html |
| 50 | index 48791b1..43a05ba 100644 |
| 51 | --- a/docs/index.html |
| 52 | +++ b/docs/index.html |
| 53 | @@ -144,7 +144,7 @@ |
| 54 | |
| 55 | <h3 id="binaries">Binaries</h3> |
| 56 | |
| 57 | - <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> |
| 58 | + <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> |
| 59 | |
| 60 | <h4 id="linux">Linux</h4> |
| 61 | |
| 62 | @@ -156,7 +156,7 @@ chmod +x pomo |
| 63 | # Copy pomo to somewhere on your $PATH |
| 64 | </code></pre> |
| 65 | |
| 66 | - <h4 id="darwin">Darwin</h4> |
| 67 | + <h4 id="osx">OSX</h4> |
| 68 | |
| 69 | <pre><code>curl -L -o pomo https://github.com/kevinschoon/pomo/releases/download/0.4.0/pomo-0.4.0-darwin-amd64 |
| 70 | # Optionally verify file integrity |
| 71 | @@ -185,6 +185,24 @@ chmod +x pomo |
| 72 | <pre><code>pomo start -t my-project "write some codes" |
| 73 | </code></pre> |
| 74 | |
| 75 | + <h2 id="configuration">Configuration</h2> |
| 76 | + |
| 77 | + <p>Pomo has a few configuration options which can be read from a JSON file in Pomo’s state directory <code>~/.pomo/config.json</code>.</p> |
| 78 | + |
| 79 | + <h3 id="colors">colors</h3> |
| 80 | + |
| 81 | + <p>You can map colors to specific tags in the <code>colors</code> field.</p> |
| 82 | + |
| 83 | + <p>Example:</p> |
| 84 | + |
| 85 | + <pre><code>{ |
| 86 | + "colors": { |
| 87 | + "my-project": "hiyellow", |
| 88 | + "another-project": "green" |
| 89 | + } |
| 90 | + } |
| 91 | + </code></pre> |
| 92 | + |
| 93 | <h2 id="roadmap">Roadmap</h2> |
| 94 | |
| 95 | <ul> |