From 402cfc69306a43ce62ddac08f877ef242df4f255 Mon Sep 17 00:00:00 2001
From: David Runge <dave@sleepmap.de>
Date: Sat, 30 Apr 2022 13:03:59 +0200
Subject: Add README for project

README.md:
Add README explaining how to call just and how to override settings.
---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

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)).
-- 
cgit v1.2.3