aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7e00f2c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# dwlb
+
+![screenshot](/screenshot.png "screenshot")
+
+dwlb is a simple bar for [dwl](https://github.com/djpohly/dwl). It is a modified version of [dtao](https://github.com/djpohly/dtao).
+
+## Installation
+```bash
+git clone https://github.com/kolunmi/dwlb
+cd dwlb
+make install
+```
+
+## Usage
+```bash
+dwl -s dwlb
+```
+
+## Status Text
+The `-status` option sends status text to existing instances of dwlb. This takes two arguments: a zxdg_output_v1 name (alternatively "all" to affect all outputs or "selected" for the current output) and the text itself.
+
+## Other Options
+Run `dwlb -h` for a full list of options.