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 @@
Binaries are available for Linux and Darwin platforms in the releases section on github.
+Binaries are available for Linux and OSX platforms in the releases section on github.
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
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