From 2efe13c858cea85163760c9ddcd4205aa52070d3 Mon Sep 17 00:00:00 2001
From: Brandon Sam Soon <brandon.samsoon@loblaw.ca>
Date: Mon, 30 Jul 2018 21:41:30 -0400
Subject: [PATCH] added basic documentation and conf file specs

---
 docs/conf/README.md  | 14 ++++++++++++++
 docs/conf/lconf.toml |  6 ++++++
 2 files changed, 20 insertions(+)
 create mode 100644 docs/conf/README.md
 create mode 100644 docs/conf/lconf.toml

diff --git a/docs/conf/README.md b/docs/conf/README.md
new file mode 100644
index 0000000..b83e633
--- /dev/null
+++ b/docs/conf/README.md
@@ -0,0 +1,14 @@
+# Lyra Configuration
+
+See `lconf.toml` for an example of a lyra configuration file. This conf file lives inside `~/.lyra`. 
+
+# Specs
+Configuration is done via a toml file. The following are the exact specification of the toml file.
+
+* `Vault` table:
+  * `enable = false`
+    * Enables vault, default set to false.
+  * `server = "http://localhost:8200"` 
+    * The url of the vault server. Default value is set to `http://localhost:8200`
+  * `ca_cert = [""]` 
+    * An array of CA certs (in PEM format) to be trusted. Usually this should be only filled if you are self signing your vault's cert. Lyra by defaults always trust your operating system's default trust store.
\ No newline at end of file
diff --git a/docs/conf/lconf.toml b/docs/conf/lconf.toml
new file mode 100644
index 0000000..1b20c9e
--- /dev/null
+++ b/docs/conf/lconf.toml
@@ -0,0 +1,6 @@
+#example of aLyra configuration
+
+[vault]
+  enable = false
+  server = "http://localhost:8200"
+  ca_cert = [""]
\ No newline at end of file