From 2d69fb2cb1c106ce5bf84bd526c6010bb44f139d Mon Sep 17 00:00:00 2001 From: Adrian Short Date: Mon, 1 Oct 2018 11:56:07 +0100 Subject: [PATCH] Update README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d87d340..1421806 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ -This is a scraper that runs on [Morph](https://morph.io). To get started [see the documentation](https://morph.io/documentation). +# Scrape planning applications for a single council/authority -This exists to enable [uk_planning_scraper](https://github.com/adrianshort/uk_planning_scraper) to be tested in the Morph environment, giving us some degree of [dev/prod parity](https://12factor.net/dev-prod-parity). \ No newline at end of file +1. Fork this repo to your own GitHub account. +2. Sign in to [Morph](https://morph.io) with your GitHub account. +3. Create a [new scraper](https://morph.io/scrapers/new) on Morph. +4. Choose your forked repo (`single_authority_planning_applications`) as the scraper code. +5. In the Morph settings page, create two `Secret environment variables`: +6. Set `MORPH_AUTHORITY_NAME` to the name of your council, eg `Hackney`. +7. Set `MORPH_DAYS` to the number of recent days you want to scrape, eg `7`. +8. Run the scraper. +9. Use the [Morph API](https://morph.io/documentation/api) to grab your scraped data or download CSV/SQLite files straight from your scraper page. You must be signed in to do that. +10. On your scraper's Settings page, tick the `Auto run` box to make your scraper run once per day.