From 52f4ae3cbfaaf29bce683ca6aed203146da32555 Mon Sep 17 00:00:00 2001
From: Kenny Levinsen <kl@kl.wtf>
Date: Fri, 2 Aug 2019 15:59:38 +0200
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..39d0930
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# wldash
+
+A dashboard/launcher/control-panel thing for Wayland.
+
+## Features
+
+- Date and time
+
+- 3 month calendar
+
+Scroll on it to navigate.
+
+- Battery level
+
+Over upower, only visible if upower battery is detected
+
+- Audio volume
+
+Over pulseaudio, only visible if pulseaudio connection is successful. Scroll to adjust volume, right-click to toggle mute.
+
+- Backlight control
+
+Using backlight sys file, only visible of backlight is detected. Scroll to adjust, right-click to toggle between the extreme values.
+
+- Launcher
+
+Works like bemenu: pipe a list into wldash, and it will print out the selection made. Use https://github.com/kennylevinsen/dot-desktop if you want to launch using desktop files.
+
+## Notable missing features:
+
+- Scaling of any kind - all sizes are currently hardcoded in pixels
+- Configurability
+- Cleanup and reorganization
\ No newline at end of file