From bedf402e798abfd48aa16afeff4afb7a42b58a1b Mon Sep 17 00:00:00 2001
From: Justin Lovinger <git@justinlovinger.com>
Date: Wed, 23 Aug 2023 21:59:46 +0000
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d00e386
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+[![Workflow Status](https://github.com/justinlovinger/owm/workflows/build/badge.svg)](https://github.com/justinlovinger/owm/actions?query=workflow%3A%22build%22)
+
+# owm
+
+An experimental [River](https://github.com/riverwm/river) layout generator
+using mathematical optimization
+to invent layouts
+on-the-fly.
+
+## Building
+
+Run `cargo build --release` or `nix build`.
+
+## Usage
+
+Add
+
+```
+riverctl default-layout owm
+owm &
+```
+
+to your River `init`.
+
+See `owm --help` for configuration options.