Add some rough documentation

1 files changed, 27 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..1d8befd
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,27 @@
+# Terraform module to create a route53 zone and IAM account to delegate letsencrypt
+
+Pretty rough, quick terraform for setting up route53, a new IAM account and
+dumping the credentials to the output.
+
+The short version is you include this in your terraform as a module:
+
+```
+source = "git::https://git.riedstra.dev/mitch/tf_letsencrypt_delegate"
+```
+
+Or so.
+
+If you don't set `use_pgp = true` and `pgp_key` to the base64 encoded
+contents of your public PGP key then it will write the credentials unencrypted
+to the state file, which you may wish to avoid.
+
+
+Adding:
+
+```
+output "info" {
+	value = module.letsencrypt.info
+}
+```
+
+To your terraform may be useful to easily retrieve the access key.