From bc8607980abc589f12aa9f21a07c5cf15b18673e Mon Sep 17 00:00:00 2001
From: Parth Shukla <52910688+parthbond180@users.noreply.github.com>
Date: Tue, 8 Nov 2022 17:58:54 +0000
Subject: [PATCH] changes to readme and config docs

---
 README.md      |  5 +++--
 docs/CONFIG.md | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 44 insertions(+), 2 deletions(-)
 create mode 100644 docs/CONFIG.md

diff --git a/README.md b/README.md
index 7454a4d..7dfd71d 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 Encloud is a toolkit for making sensitive data useful for Web3. The Encloud CLI enables clients to easily on-board 
 sensitive data to the Filecoin network. 
 
-Encloud CLI is a lightweight utility that allows clients to 
+Encloud Encryption and Storage CLI is a lightweight utility that allows clients to 
 
 - Generate their RSA encryption keys
 - Manage file and encryption metadata in a local or remote KV store
@@ -11,7 +11,7 @@ Encloud CLI is a lightweight utility that allows clients to
 - Retrieve encrypted files from Filecoin and decrypt them
 - Share encrypted files by transferring the DEK to a specified email
 
-Encloud currently uses the [Estuary](https://estuary.tech/) API to upload and retrieve data from Filecoin. This allows clients to interact with the 
+Encloud currently uses the [**Estuary**](https://estuary.tech/) API to upload and retrieve data from Filecoin. This allows clients to interact with the 
 Filecoin network without needing to deal with crypto wallets, tokens or deal making with Filecoin storage providers as 
 Estuary manages this in the background.
 
@@ -23,6 +23,7 @@ Read [**here**](docs/DESIGN.md) for detailed **design and architecture**
 
 ## Prerequisites
 - Golang 1.18 or higher
+- Estuary API account and key. Read [more](docs/CONFIG.md)
 
 ## CLI Setup
  
diff --git a/docs/CONFIG.md b/docs/CONFIG.md
new file mode 100644
index 0000000..61a7198
--- /dev/null
+++ b/docs/CONFIG.md
@@ -0,0 +1,41 @@
+# Configuration
+
+Encloud Encryption and Storage CLI provides an ability to configure the various aspects of the application to suit the clients needs.
+
+The following can be configured:
+
+* Filecoin on-boarding and deal making mechanism (Estuary support offered currently)
+* Metadata Storage Mechanism (BadgerDB support offered currently) 
+* Email settings for sharing of DEKs for encrypted files on Filecoin
+
+## Estuary 
+
+Encloud Encryption and Storage CLI uses Estuary as a means to onboard and retrieve data from the Filecoin network. Estuary requires the client
+to generate an API Key which can be requested [here](https://docs.estuary.tech/tutorial-get-an-api-key). 
+
+The Estuary API key needs to be configured under [config.yml](../config.yml) as follows under the `estuary` section:
+
+```yaml
+estuary:
+  base_api_url: "https://api.estuary.tech"
+  download_api_url: "https://dweb.link/ipfs"
+  shuttle_api_url: "https://shuttle-4.estuary.tech"
+  token: "XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
+```
+
+## Email and sharing
+
+We utilize emails to share DEKs from the client directly to the email of an entity they want to share the data with. It is 
+worth noting that once the DEK is shared with an entity they can download the data from Filecoin and decrypt it.
+
+The following configs need to be made for emails under [config.yml](../config.yml), under the `email` section:
+
+```yaml
+email:
+  server: "smtp.acme.io"
+  port: 2525
+  username: "XXXXXXXXXXXXX"
+  password: "XXXXXXXXXXXXX"
+  from: "noreply@acme.com"
+```
+