aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorVidhu Kant Sharma <vidhukant@vidhukant.com>2025-09-10 01:21:09 +0530
committerVidhu Kant Sharma <vidhukant@vidhukant.com>2025-09-10 01:21:09 +0530
commit708587943595fb3231647f2da5d17b8202db34e8 (patch)
tree98f542795c2d1b1fe14c85897e08b3e49a1cd17f /README.md
parentef6e3a4006522da925004fdcbbc531c520844fb6 (diff)
Added installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1f92edb..f8bcf3a 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,25 @@ the same widget. It can be controlled through the polydoro command, which can ev
added to your statusbar (clicked, etc) or can be controlled through your window manager's
keybindings.
+# Installation
+
+Using cargo install:
+
+```fish
+cargo install polydoro
+```
+
+Build from source:
+
+```
+git clone https://git.vidhukant.com/polydoro/
+cd polydoro
+cargo build -r
+
+# optionally move this binary to $PATH
+./target/release/polydoro
+```
+
# Usage
## Starting the daemon