Added readme

This commit is contained in:
Alexander Munch-Hansen 2018-10-09 22:09:27 +02:00
parent 0bae9f4587
commit 17bc07fa57
1 changed files with 5 additions and 0 deletions

5
README.md Normal file
View File

@ -0,0 +1,5 @@
## Usage
The program can be started by running `python3 apartment_looker.py` in which case it'll create a file for each
website it looks at, it'll populate each file with the apartments it finds and it'll send an email to specific email
with a link to each apartment. The program can be run without sending emails like
`python3 apartment_looker.py --populate_lists`, in which case it'll just populate the json files.