From 9d8a6aa23c38655cde787781b06015231ae68e4b Mon Sep 17 00:00:00 2001
From: James Page <james.page@ubuntu.com>
Date: Fri, 1 Jul 2016 10:15:04 +0100
Subject: [PATCH] Add a README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..39287f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Overview
+
+This layer provides the base layer for OpenStack charms that are will deploy
+API services, and provides all of the core functionality for:
+
+ - HA (using the hacluster charm)
+ - SSL (using configuration options or keystone for certificates)
+ - Juju 2.0 network space support for API endpoints
+ - Configuration based network binding of API endpoints
+
+To use this layer, including the following in the layer.yaml of your charm:
+
+    include: ['layer:openstack-principle']
+
+And then read the [new API charm](https://github.com/openstack/charm-guide/blob/master/doc/source/new-charm.rst)
+guide for details on how to use this layer in-conjuction with the
+charms.openstack Python module to quickly and easily put together a
+new API charm.