From b604a9d5fa449f0bda5422d1f2ed429981ac97e4 Mon Sep 17 00:00:00 2001
From: Dan Howe <d.howe@wrl.unsw.edu.au>
Date: Fri, 16 Aug 2019 10:54:22 +1000
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0581daa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# spectur
+
+Open an automated selenium webdriver, and download images from Live View mode.
+
+## Requirements
+
+You must have the [mozilla geckodriver](https://github.com/mozilla/geckodriver/releases)  in your path. The simplest way to do this is store it in the same folder as the `spectur_live_view.py` script.
+
+## Usage
+
+```
+python spectur_live_view.py
+```
+
+By default, you will be asked to login manually. If you would like to login automatically, set appropriate values to the `username` and `password` variables in the script header.