Initial import0.1.0

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..277671a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# 🍅 Tomato, yet another Pomodoro tool
+
+## Why?
+
+Because I'm learning Haskell and this seemed a simple little tool to write in a couple of hours.
+
+## Install
+
+Using [cabal](https://www.haskell.org/cabal/):
+
+```
+git clone https://git.usebox.net/tomato-hs
+cd tomato-hs
+cabal install tomato
+```
+
+## How to use it
+
+You can always read the CLI help with `tomato -h`, but basically:
+
+* `tomato start` starts a 45 minutes Pomodoro (default, use `-t` to specify a different number).
+* `tomato` or `tomato show` shows the time left in current Pomodoro (if any).
+* `tomato stop` stops current Pomodoro (if any).
+
+The state is saved on your `XDG_CACHE_HOME` directory (usually `$HOME/.cache`). If The tool has issues finding the directy, you can use `-s` option to specify a location.
+
+## Using it from tmux
+
+You can add `tomato` o tmux with:
+
+```
+set -g status-interval 1
+set -g status-right "#(tomato)"
+```
+