From a4dce055c2332fc06079d516df8de6a4fa016324 Mon Sep 17 00:00:00 2001 From: Russell Hall Date: Sun, 17 Jul 2022 19:18:33 +0100 Subject: [PATCH] add documentation --- doc/source/wiltshire_gov_uk.md | 42 +++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/doc/source/wiltshire_gov_uk.md b/doc/source/wiltshire_gov_uk.md index 17498c84..c0fffdd8 100644 --- a/doc/source/wiltshire_gov_uk.md +++ b/doc/source/wiltshire_gov_uk.md @@ -1 +1,41 @@ -TODO: \ No newline at end of file +# Wiltshire Council + +Support for schedules provided by [Wiltshire Council](https://wiltshire.gov.uk/). + +If collection data is available for the address provided, it will return household and recycling waste collection dates. + +## Configuration via configuration.yaml + +```yaml +waste_collection_schedule: + sources: + - name: wiltshire_gov_uk + args: + postcode: POSTCODE + uprn: UPRN +``` + +### Configuration Variables + +**postcode**
+*(string) (required)* + +**uprn**
+*(string) (required)* + +Both the postcode and the UPRN should be supplied in the arguments. + +## Examples + +```yaml +waste_collection_schedule: + sources: + - name: wiltshire_gov_uk + args: + postcode: BA149QP + uprn: 100121085972 +``` + +## How to find your UPRN + +An easy way to discover your Unique Property Reference Number (UPRN) is by going to [Find My Address](https://www.findmyaddress.co.uk/) and providng your address details. \ No newline at end of file