1 files changed, 30 insertions, 0 deletions
diff --git a/river/README.md b/river/README.md
new file mode 100644
index 0000000..3285628
--- /dev/null
+++ b/river/README.md
@@ -0,0 +1,30 @@
+# astal-river
+
+a library and cli tool for getting status information of the river wayland compositor.
+
+## Build from source
+### Dependencies
+
+- meson
+- glib
+- gobject-introspection
+- json-glib
+- libwayland
+
+```sh
+# Clone the repository
+git clone https://github.com/astal-sh/river
+cd river
+
+# Setup and build
+meson setup build
+meson compile -C build
+
+# Install
+meson install -C build
+```
+
+## Todo
+- docs
+
+