From a9628796df28c0fa159ea45dda6de33a6f6ed570 Mon Sep 17 00:00:00 2001 From: Samer Albahra Date: Tue, 17 Mar 2015 21:54:34 -0500 Subject: [PATCH] Readme: Add description and disclosure --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c0fb3cd..0db530a 100644 --- a/README.md +++ b/README.md @@ -1 +1,9 @@ -# Weather-Adjustment +# Weather Adjustment Service + +This script is used by OpenSprinkler Unified Firmware to update the water level of the device. It also provides timezone information based on user location along with other local information (sunrise, sunset, daylights saving time, etc). + +The production version runs on Amazon Elastic Beanstalk (AWS EB) and therefore this package is tailored to be zipped and uploaded to AWS EB. The script is written in Python. + +The requirements.txt is used to define the required Python modules needed to run the script. Application.py parses the incoming URL and returns the appropriate values. The script defaults to URL format return however a 'format' parameter can be passed with the value 'json' in order to output JSON. + +The script does use Google Analytics to collect anonymous data regarding each query such as the firmware of the device querying, the location entered in the device options, and result of the water adjustment.