aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCara Salter <cara@devcara.com>2022-04-28 14:55:39 -0400
committerCara Salter <cara@devcara.com>2022-04-28 14:56:21 -0400
commit7f1fc0444f8ae7a4c1263881a151eb3d2991bbb8 (patch)
treee2114313871caa7b37da7097f5e7911f944d4235 /README.md
parentbc3132f22f3470d8b1d8189e23393d3bb4577480 (diff)
downloadsolard-7f1fc0444f8ae7a4c1263881a151eb3d2991bbb8.tar.gz
solard-7f1fc0444f8ae7a4c1263881a151eb3d2991bbb8.zip
main: Make bind address an environment variable
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
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;
+ };
+}
+```