aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Runge <dave@sleepmap.de>2022-04-30 13:03:59 +0200
committerDavid Runge <dave@sleepmap.de>2022-04-30 13:06:38 +0200
commit402cfc69306a43ce62ddac08f877ef242df4f255 (patch)
tree5b3e4bb7479438db2153e8cace36959a76f9cb1c
parentda770a0aa6e032391c75abc9cd49afaa332f629e (diff)
downloadwkd-402cfc69306a43ce62ddac08f877ef242df4f255.tar.gz
wkd-402cfc69306a43ce62ddac08f877ef242df4f255.tar.bz2
wkd-402cfc69306a43ce62ddac08f877ef242df4f255.tar.xz
wkd-402cfc69306a43ce62ddac08f877ef242df4f255.zip
Add README for project
README.md: Add README explaining how to call just and how to override settings.
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..961eee5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# WKD
+
+This repository tracks data (PGP public key certificates) and scripts to create
+a WKD setup for a domain.
+
+## Requirements
+
+* [just](https://github.com/casey/just)
+* [rsync](https://rsync.samba.org/)
+* [sequoia-sq](https://sequoia-pgp.org/)
+
+## Usage
+
+To use the default `fqdn`, `remote` and `location` to deploy for, use
+
+```bash
+just
+```
+
+To set the `fqdn` and `remote` use:
+
+```bash
+just --set fqdn example.com --set remote user@example.com --set location /some/location/on/remote
+```
+
+The above assumes that PGP public key certificates are available in the
+[certs](certs) directory for the given fqdn.
+
+## License
+
+WKD is licensed under the terms of the **GPL-3.0-or-later** (see
+[LICENSE](LICENSE)).