From 3082ae0564e2950a88dd550a2f49fded75b8a72b Mon Sep 17 00:00:00 2001
From: James Page <james.page@ubuntu.com>
Date: Tue, 24 Jun 2014 15:11:30 +0100
Subject: [PATCH] Tweak docs to look nicer

---
 README.md | 42 ++++++++++++++++++++++++++----------------
 1 file changed, 26 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index b453372b..e73aafd9 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,28 @@
-Overview                                                                                                                                                                                                      
---------
+# Overview 
 
-This principle charm provides the Neutron API service which was previously
-provided by the nova-cloud-controller charm. When this charm is joined with
-the nova-cc charm the nova-cc charm will shutdown its api service, deregister
-it from neutron and inform the compute nodes of the new neutron url. This
-charm expects the following relations:
+This principle charm provides the OpenStack Neutron API service which was previously provided by the nova-cloud-controller charm.
 
-1) neutron-plugin-api relation with subordinate neutron plugin charms
-   (such as neutron-openvswitch)
-2) neutron-api relation with nova-cloud-controller
-3) Database backend
-4) amqp relation with message broker. If a single message broker is being used for 
-   the openstack deployemnt then it can relat to that. If a seperate neutron 
-   message broker is being used it should relate to that.
-5) identity-service relation
-6) ha relation with ha subordinate
+When this charm is related to the nova-cloud-controller charm the nova-cloud controller charm will shutdown its api service, de-register it from keystone and inform the compute nodes of the new neutron url.
+
+# Usage
+
+To deploy (partial deployment only):
+
+    juju deploy neutron-api
+    juju deploy neutron-openvswitch
+
+    juju add-relation neutron-api mysql
+    juju add-relation neutron-api rabbitmq-server
+    juju add-relation neutron-api neutron-openvswitch
+    juju add-relation neutron-api nova-cloud-controller
+
+This charm also supports scale out and high availability using the hacluster charm:
+
+    juju deploy hacluster neutron-hacluster
+    juju add-unit neutron-api
+    juju set neutron-api vip=<VIP FOR ACCESS>
+    juju add-relation neutron-hacluster neutron-api
+
+# Restrictions
+
+This charm only support deployment with OpenStack Icehouse or better.