From 13a4235e5a0a6131b15692a7788c869e4132e1b0 Mon Sep 17 00:00:00 2001
From: Joel Collins <joel@jtcollins.net>
Date: Thu, 28 Feb 2019 09:37:45 +0000
Subject: [PATCH] Updated readme

---
 README.md | 47 ++++++++++-------------------------------------
 1 file changed, 10 insertions(+), 37 deletions(-)

diff --git a/README.md b/README.md
index 0a1b2b61..3ee614df 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,15 @@
 # OpenFlexure.vue
+A user client for the OpenFlexure Microscope, written in Vue.js.
+
+## Install
+
+* Installers for Linux, Raspberry Pi, Windows and MacOS will be released soon.
+
+## Develop
+* Clone the repo, and run `npm install`
+* Scripts to build, and package Electron apps, are included in `package.json`
 
 ## To-do
-* ~~Connect~~
-    * ~~Connect to user-input IP~~
-    * ~~Store connection in vuex store~~
-
-* ~~Move~~
-    * ~~Read absolute position~~
-    * ~~Change absolute position~~
-    * ~~Keyboard movement~~
-    * ~~Mouse scroll focus~~
-    * ~~Double-click to centre~~
-
-* Gallery
-    * ~~Basic card for each capture~~
-    * ~~Thumbnails~~
-    * ~~Reload button~~
-    * ~~Download buttons~~
-        * ~~Lightbox~~
-        * ~~Save to disk~~ (Redundant by context menu)
-    * ~~Basic info/metadata modal~~
-    * ~~Tags~~
-        * ~~Read tag list~~
-        * ~~Add tag button~~
-        * ~~Delete tag button~~
-    * ~~Tag filter~~
-
-* ~~Capture~~
-    * ~~UI elements for capture options~~
-    * ~~Big, friendly capture button~~
-    * ~~Metadata for captures~~
-    * ~~Tags for captures~~
-
-* Plugins
-    * ~~Placeholder for other plugins~~
-    * Accordion for:
-        * ~~Autofocus~~ (Needs functionality added to placeholders)
-        * ~~Recalibrate~~
 
 * Settings
-    * Metadata keys to automatically add (e.g. userID, patientID)
\ No newline at end of file
+  * Metadata keys to automatically add (e.g. userID, patientID)
\ No newline at end of file