From 18956bf230c36fecb01864c2d177227664d6566c Mon Sep 17 00:00:00 2001
From: Joel Collins <2579603-jtc42@users.noreply.gitlab.com>
Date: Wed, 9 Dec 2020 16:04:23 +0000
Subject: [PATCH] Update README.md

---
 openflexure_microscope/api/static/README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/openflexure_microscope/api/static/README.md b/openflexure_microscope/api/static/README.md
index 4e5d9005..2a49382d 100644
--- a/openflexure_microscope/api/static/README.md
+++ b/openflexure_microscope/api/static/README.md
@@ -1,8 +1,20 @@
 # OpenFlexure Microscope JS Client
 
-## Developer notes
+## Key info
 
-### VS Code and ESLint
+* Vue.js web application providing a graphical interface for the OFM
+* Once built, will be served by the API server from the host root on port 5000
+
+* See [openflexure-microscope-server/README.md](https://gitlab.com/openflexure/openflexure-microscope-server/-/blob/master/README.md) for details on local installation and building
+
+# Developer guidelines
+
+## Creating releases
+
+* JS client is coupled to the API, and so are no longer separately built and deployed.
+* See [openflexure-microscope-server/README.md](https://gitlab.com/openflexure/openflexure-microscope-server/-/blob/master/README.md) for details on creating new releases
+
+## VS Code and ESLint
 
 To prevent the editor from interfering with ESLint, add to your project `settings.json`: