1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..556b26b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+<a href="https://github.com/fuwn/lime">
+<h1 align="center">🧶 lime</h1>
+</a>
+<p align="center">
+no bs url shortening
+</p>
+<p align="center">
+<img src="./assets/screenshot_index.png" alt="screenshot of index page">
+</p>
+
+## nix
+- build: `nix-build`
+- docker: `nix-build docker.nix`
+
+## usage (without docker)
+- run (dev): `cargo run`
+
+## development dependencies
+### required
+- [diesel_cli](https://crates.io/crates/diesel_cli)
+- [cargo-make](https://github.com/sagiegurari/cargo-make)
+
+### optional
+- [cargo-watch](https://crates.io/crates/cargo-watch)
+
+*these development dependencies will automatically be satisfied if you are using the nix
+shell configuration as provided.*
+
+### license
+[gnu general public license v3.0](./license)