chore: add README.md

1 files changed, 38 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..639e997
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# [zone]
+
+[![builds.sr.ht status](https://builds.sr.ht/~tobyvin/zone.svg)](https://builds.sr.ht/~tobyvin/zone?)
+
+A lightweight container management system.
+
+This project is in the **EARLY** developmental stage
+
+## Usage
+
+Run `zone --help` to get started.
+
+## Installation via Cargo
+
+    # Install the cli tool and daemon
+    cargo install --git=https://git.sr.ht/~tobyvin/zone zone zoned
+
+## Building
+
+    git clone https://git.sr.ht/~tobyvin/zone
+    cd zone
+    cargo build
+
+## Contributing
+
+Send patches to the [mailing list], report bugs on the [issue tracker].
+
+For help sending patches to this list, please consult [git-send-email.io].
+
+## License
+
+MIT License, see [license].
+
+[zone]: https://sr.ht/~tobyvin/zone/
+[mailing list]: https://lists.sr.ht/~tobyvin/zone-devel
+[issue tracker]: https://todo.sr.ht/~tobyvin/zone
+[git-send-email.io]: https://git-send-email.io/
+[license]: LICENSE