aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexander Kiryukhin <a.kiryukhin@mail.ru>2021-12-13 15:39:41 +0300
committerAlexander Kiryukhin <a.kiryukhin@mail.ru>2021-12-13 15:43:34 +0300
commitcc47f2e55654b459f20520b3c4221473903cbddc (patch)
treea5ece0447f228008a4ccd88a1bd21c8ce515ee84 /README.md
parent58160f5a65978db90dcbac85d76ad7e960cfa6ff (diff)
initial
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
index b1855c3..b6624e3 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
# pomodoro
Pomodoro timer for nerds
+
+## Installation
+
+### Binaries
+
+Grab binaries for different OS from https://github.com/neonxp/pomodoro/releases
+
+### Homebrew
+
+```
+brew install neonxp/tap/pomodoro
+```
+
+### With golang
+```
+go install github.com/neonxp/pomodoro@latest
+```
+
+## Usage
+
+Just run
+
+```shell
+pomodoro
+```
+
+to stop - press Ctrl+C or kill process \ No newline at end of file