Add example files

Add example JSON files to inform users how to use JSON keys.

.gitignore

@@ -0,0 +1,2 @@
+
+*.json

README.md

@@ -1,2 +1,16 @@
-# Eruv-Alerts
- This project sends an SMS to every subscriber from an Eruv Alerts Google Spreadsheet, based on the city's status.
+# Eruv Alerts
+This project sends an SMS to every subscriber from an Eruv Alerts Google Spreadsheet, based on the city's status.
+
+## Requirements
+
+The script requires both a Google Spreadsheet and a Twilio account to send SMS messages. Although not required, it also tries to use openweathermap.org for weather.
+
+All of the authentication keys used should be saved in the keys/ folder. The example keys contained within are examples of what they should contain.
+
+To generate Google Spreadsheet credentials, follow this tutorial:
+https://gspread.readthedocs.io/en/latest/
+
+These can be installed with pip:
+```bash
+pip3 install gspread twilio oauth2client
+```

keys/google_auth.json.example

@@ -0,0 +1,12 @@
+{
+  "type": "service_account",
+  "project_id": "Name of project",
+  "private_key_id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+  "private_key": "-----BEGIN PRIVATE KEY-----XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-----END PRIVATE KEY-----",
+  "client_email": "[email protected]",
+  "client_id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://accounts.google.com/o/oauth2/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.iam.gserviceaccount.com"
+}

keys/open_weather_map.json.example

@@ -0,0 +1,3 @@
+{
+  "api-key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+}

keys/twilio_auth.json.example

@@ -0,0 +1,5 @@
+{
+  "account-sid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+  "password": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+  "phone" : "+11234567890"
+}

requirements.txt

@@ -0,0 +1,3 @@
+gspread==3.4.2
+oauth2client==4.1.3
+twilio==6.38.1