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= +SWVX_API_PASSWORD= +``` + +`switchvox-did-usage-report --csv=` + +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: +`:` + +`switchvox-did-usage-report --csv= --credentials=`