1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..17f47fa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Waifud
+
+Providing a RESTful interface to a machine's virtual machines (waifus).
+
+## Flake Options
+
+Example:
+
+```nix
+{ config, pkgs, ... }:
+{
+	cara.services.waifud = {
+		enable = true;
+		environmentFileLocation = "/var/lib/waifud/.env";
+		port = 3000;
+	};
+}
+```