From a481f4950a82ef83329665b50cb227160d653e5e Mon Sep 17 00:00:00 2001
From: Vivian Roest <vivian@0x76.dev>
Date: Tue, 2 May 2023 09:34:26 +0200
Subject: [PATCH] some docs

---
 README.md         | 14 +++++++++++++-
 example_keys.json |  7 +++++++
 2 files changed, 20 insertions(+), 1 deletion(-)
 create mode 100644 example_keys.json

diff --git a/README.md b/README.md
index 96d9af6..f64b699 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
 # Vault Unsealer
-This is a simple Rust program that automatically unseals a hashicorp vault instance
+This is a simple Rust program that automatically unseals a hashicorp vault instance.
+
+| :exclamation: this method of unsealing the vault is not recommended if you have high security requirements!  |
+|-----------------------------------------|
+
+
+## Environment Variables
+
+| env var    | default | description |
+| ---------- | ------- | ----------- |
+| VAULT_ADDR |    -    | address of the vault server |
+| VAULT_KEY_FILE | - | json file containing vault unseal key(s), see [./example_keys.json](./example_keys.json) |
+| UNSEAL_INTERVAL | 15 | seconds to wait between checks / unseal attempts |
diff --git a/example_keys.json b/example_keys.json
new file mode 100644
index 0000000..84daa77
--- /dev/null
+++ b/example_keys.json
@@ -0,0 +1,7 @@
+{
+    "keys": [
+        "a",
+        "b",
+        "c"
+    ]
+}