diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e4c08b --- /dev/null +++ b/README.md @@ -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.