From 738d322f35caf17a8340a2aa3526f011d8bd4902 Mon Sep 17 00:00:00 2001
From: Bryan Ndjeutcha <ndjeutcha@gmail.com>
Date: Mon, 24 May 2021 18:05:16 -0400
Subject: [PATCH] README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..91006d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# A [river](https://github.com/ifreund/river)-status client
+
+This client is useful if you want to have a workspace module for somethig like [eww](https://github.com/elkowar/eww) or [waybar](https://github.com/Alexays/Waybar).
+
+I also plan to add an option to display the title of the focused window.
+
+### Dependencies
+- rust
+
+## Building
+
+```shell
+git clone https://gitlab.com/snakedye/ristate.git
+cd ristate
+cargo build --release