From 6e169e5e20798368434b8efc2da936ba6d6bc793 Mon Sep 17 00:00:00 2001
From: Ben D <ben@noreply.localhost>
Date: Mon, 23 Jan 2023 13:04:19 -0800
Subject: [PATCH] Update 'README.md'

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 50ba66b..cd450bb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
-# switchvox-did-usage-report
+# Switchvox DID Usage Report
+Takes a list of DID's from a `csv` file and pulls usage report from `api.switchvoxuc.com`.
+
+
+## CSV File.
+The file should have the following headers
+
+The file should have a single header `csv` or can be a document with one number per line with no headers.
+
+
+## Usage
+Set your authentication information as a shell variable.
+
+```
+SWVX_API_USERNAME=<YOUR API USERNAME>
+SWVX_API_PASSWORD=<YOUR API PASSWORD>
+```
+
+`switchvox-did-usage-report --csv=<PATH TO CSV FILE>`
+
+Alternatively you can store your credentials in a file and pass that file to the script.
+>This should be kept only accessable by administrators. As the contents are not encrypted.
+
+Store your username password as such:
+`<USERNAME>:<PASSWORD>`
+
+`switchvox-did-usage-report --csv=<PATH TO CSV FILE> --credentials=<CREDENTIALS FILE>`