added readme
This commit is contained in:
29
README.md
Normal file
29
README.md
Normal file
@@ -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.
|
||||||
Reference in New Issue
Block a user