From 1edeff78d8f075719326cd82431b90d2af1badda Mon Sep 17 00:00:00 2001
From: James Page <james.page@ubuntu.com>
Date: Fri, 9 Nov 2018 11:15:56 +0000
Subject: [PATCH] Add basic README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..123250c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# microstack
+
+[![Snap Status](https://build.snapcraft.io/badge/CanonicalLtd/microstack.svg)](https://build.snapcraft.io/user/CanonicalLtd/microstack)
+
+OpenStack in a snap that you can run locally.
+
+## User Guide
+
+`microstack` is frequently updated to provide the latest stable updates of the most recent OpenStack release.  The quickest was to get started is to install directly from the snap store.  You can install `microstack` using:
+
+```
+sudo snap install microstack --classic --edge
+```
+
+Once the snap is installed, you need to perform a one off configuration process:
+
+```
+sudo microstack.configure
+```
+
+This will initialize all OpenStack services, configure access, network and an image to use on the local OpenStack deployment.
+
+## Accessing OpenStack
+
+`microstack` provides a pre-configured OpenStack CLI to access the local OpenStack deployment; its namespace using the `microstack` prefix:
+
+```
+microstack.openstack server list
+```
+
+## Stopping and starting microstack
+
+You may wish to temporarily shutdown microstack when not in use without un-installing it.
+
+microstack can be shutdown using:
+
+```
+sudo snap disable microstack
+```
+
+and re-enabled latest using:
+
+```
+sudo snap enable microstack
+```