From 708db6bf9be73b49e7e103d16ad639af012ef619 Mon Sep 17 00:00:00 2001
From: Patrick McDonagh <patrickjmcd@gmail.com>
Date: Thu, 23 Feb 2017 18:49:03 -0600
Subject: [PATCH] Added a README file

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4a159f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# POCloud-Scraper
+Scrape production data from POCloud to push to accounting servers
+
+# Setup
+System variables must be set up for the script to run.
+```
+export HP_SQL_USER="<yourSQLusername>"
+export HP_SQL_PASSWORD="<yourSQLpassword>"
+export HP_SQL_SERVER="<yourSQLserverAddress>"
+export MESHIFY_USERNAME="<yourMeshifyUsername>"
+export MESHIFY_PASSWORD="<yourMeshifyPassword>"
+```
+
+# Usage
+It is useful to run the script and store the output in a log file.
+
+## Test Mode
+The script has a test mode which will only retrieve the data. Test mode will not write date to the database. 
+
+To run the script in test mode:
+```
+python3 henryPetroleumMeshifyAPI.pt True >> output.log
+```
+
+## Normal Mode
+In normal mode, the data will be grabbed from the Meshify API and inserted into the Production database.
+
+To run the script:
+```
+python3 henryPetroleumMeshifyAPI.pt >> output.log
+```
+