From 5d4a4b61b61c92929f1b9884394809db02d57bb1 Mon Sep 17 00:00:00 2001
From: acid <seancusack@gmail.com>
Date: Sat, 6 Mar 2021 16:33:15 +0000
Subject: [PATCH] added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..63c4b72
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Web Scraper
+
+## Installation
+
+Either download a copy of the script, or use to git clone to grab a copy
+
+```sh
+git clone https://git.cusack.cloud/acid/web-scraper.git
+```
+
+Create a virtual environment and then activate it
+
+```sh
+cd web-scraper
+python3 -m venv .
+source bin/activate
+```
+
+Install requirements
+
+```sh
+pip install -r requirements.txt
+```
+
+## Usage
+
+Copy the .env_sample to .env and fill in your twilio details to send SMS messages
+
+Edit the config object in scrape.py to point to the URL to be monitored.
\ No newline at end of file