diff --git a/README.md b/README.md index 62593b2..2452afa 100644 --- a/README.md +++ b/README.md @@ -15,26 +15,26 @@ This script can be run two ways either as a stand alone script that's scheduled ### Running as a GitHub Action -There is a workflow within this repository [check-binday.yaml](.github/workflows/check-binday.yml) which is scheduled for early morning each day to check for bin collections. This workflow requires two secrets, firsly the [UPRN](https://www.findmyaddress.co.uk/search) to be checked for, and the [ntfy.sh](https://ntfy.sh/) topic to publish the message to. Then you'll start recieving notifications when you'll need to put bins out and which bin it is. +There is a workflow within this repository [check-binday.yaml](https://github.com/joe-mccarthy/harlow-bindicator/blob/main/.github/workflows/check-binday.yml) which is scheduled for early morning each day to check for bin collections. This workflow requires two secrets, firsly the [UPRN](https://www.findmyaddress.co.uk/search) to be checked for, and the [ntfy.sh](https://ntfy.sh/) topic to publish the message to. Then you'll start recieving notifications when you'll need to put bins out and which bin it is. ### Running locally -The set up is very similar to how it's run on GitHub actions, with the requirement of a uprn and a ntfy.sh topic. Running the script is as simple as +The script requires additional tools to run, in order to load the webpage that provides the bin information from Harlow Local Authority which is the chromium-chromedriver, just run the command below. ```bash -python src/main.py --uprn "12379870" --topic "topic-name" +sudo apt-get install chromium-chromedriver ``` -However before running the script be sure to installe the requirements for python with +Install Harlow Bindicator ``` -pip install -r requirements +pip install harlow-bindicator ``` -The script also requires additional tools to run, in order to load the webpage that provides the bin information from Harlow Local Authority which is the chromium-chromedriver, just run the command below. +The set up is very similar to how it's run on GitHub actions, with the requirement of a uprn and a ntfy.sh topic. Running the script is as simple as ```bash -sudo apt-get install chromium-chromedriver +harlow-bindicator--uprn "12379870" --topic "topic-name" ``` ## Contributing diff --git a/pyproject.toml b/pyproject.toml index 423616c..6f280aa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "harlow-bindicator" -version = "2.2.1" +version = "2.2.2" description = "Send alert the day before and on the day of bin collection in Harlow" authors = ["Joe McCarthy <179146301+joe-mccarthy@users.noreply.github.com>"] readme = "README.md"