From 4d1dde9004828528280a9c80b1f351d8a96dc788 Mon Sep 17 00:00:00 2001
From: jornmann <jornmann32@gmail.com>
Date: Thu, 7 Apr 2022 15:15:37 +0300
Subject: [PATCH] create a readme

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..404a1b6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# candybar
+a stupidly simple modular statusbar
+
+## usage
+**candybar** only outputs the text that should be shown on the bar, which makes it useable on different applications.
+### usage with dwm
+add the following to your ~/.xinitrc:
+```sh
+while true; do
+	xsetroot -name "$(candybar)"
+	sleep 2
+done
+```
+### usage with tmux
+add the following to your ~/.tmux.conf:
+```tmux
+set -g status-interval 2
+set -g status-right-length 100
+set -g status-right "#(candybar)"
+```