Added README file.
[dwm-status] / README.md
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..89e3339
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Overview #
+
+Updates the status bar for `dwm` to display the load average, date and time.
+
+# Status #
+
+Complete. Tested on FreeBSD 13.
+
+# Instructions #
+
+Simply `make clean all` and copy the resulting `dwmstatus` binary anywhere
+desired. Remember to call it from `~/.xinitrc` so it starts automatically when
+X starts up.