From 7db28b3793d79beba93ec9f515c54e112bb21217 Mon Sep 17 00:00:00 2001
From: Brian Picciano <mediocregopher@gmail.com>
Date: Mon, 15 May 2023 21:46:40 +0200
Subject: [PATCH] readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4b2c7bd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Domiply
+
+Domiply is a self-hosted rust service which connects a DNS hostname to a data
+backend (e.g. a git repository), all with no account needed. The user only
+inputs their domain name, their desired backend, and then adds two entries to
+their DNS server.
+
+[Demo which may or may not be live](https://domiply.mediocregopher.com)
+
+## Development
+
+Domiply uses nix flakes for building and setting up the development environment.
+In order to open a shell with all necessary tooling (expected rust toolchain
+versions, etc...) simply do:
+
+```
+nix develop
+```
+
+Within the shell which opens you can do `cargo run` to start a local instance.
+
+In order to create a release binary:
+
+```
+nix build
+```
+
+## Roadmap
+
+Check out the `src/service/http_tpl/index.html` file for the current roadmap.