From 1fc66167fa00efcf370b2d2819f80ab3cca42eda Mon Sep 17 00:00:00 2001
From: Dan Howe <d.howe@wrl.unsw.edu.au>
Date: Fri, 17 Aug 2018 16:28:20 +1000
Subject: [PATCH] Add readme

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..508d37e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# major_projects_grabber #
+
+**major_projects_grabber** download documents from the NSW DPE Major Projects website.
+http://majorprojects.planning.nsw.gov.au
+
+## Installation ##
+
+```
+http://git.wrl.unsw.edu.au:3000/danh/major-projects-grabber.git
+pip install -e major-projects-grabber
+```
+
+## Usage ##
+
+### Single modification
+
+The URL of each modification page on the DPE Major Projects website ends with a job id, e.g.:
+
+majorprojects.planning.nsw.gov.au/index.pl?action=view_job&**job_id=1746**
+
+This job id can be used to download all documents associated with a particular modification:
+
+```
+major_projects_grabber -i 1746
+```
+
+### List of search results
+
+The DPE portal's search function takes you to a page of search results with a URL like this:
+
+http://majorprojects.planning.nsw.gov.au/index.pl?action=search&page_id=&search=&authority_id=425&search_site_type_id=&reference_table=&status_id=&decider=&from_date=&to_date=&x=44&y=10
+
+This URL can be used to download all documents for each modifications in the search results page:
+
+```
+major_projects_grabber -u "http://majorprojects.planning.nsw.gov.au/index.pl?action=search&authority_id=547"
+```
+
+### Output directory
+
+The output directory to save the downloaded documents can be specified with the `-o` option, e.g.:
+
+```
+major_projects_grabber -i 1746 -o "DPE documents"
+```
+
+If no output directory is specified, the current directory is used.