summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorBrian Rosmaita <brian.rosmaita@rackspace.com>2016-11-02 16:23:36 -0400
committerBrian Rosmaita <brian.rosmaita@rackspace.com>2016-11-03 16:26:16 -0400
commitc7e5c18c874b44f807d8084fff9755ad8e2d9110 (patch)
tree4eefca0d39cc5f844729ee175a81f9ac675f8fe8 /README.rst
parent9ba10d8e257bf3324487538b98ec10f2a2e28f45 (diff)
downloadglance_store-c7e5c18c874b44f807d8084fff9755ad8e2d9110.tar.gz
Update README
This patch updates the README for the glance_store repository along the lines discussed at the session at the Ocata design summit. See the session etherpad [0] for details. Co-authored-by: Ian Cordasco <sigmavirus24@gmail.com> Co-authored-by: Brian Rosmaita <brian.rosmaita@rackspace.com> [0] https://etherpad.openstack.org/p/ocata-glance-glance-store-refactoring Change-Id: Iac83c515e12ec953f4814e7cbeeca33c034d7497
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 3924099..6eb7059 100644
--- a/README.rst
+++ b/README.rst
@@ -1,8 +1,16 @@
Glance Store Library
-=====================
+====================
Glance's stores library
+This library has been extracted from the Glance source code for the
+specific use of the Glance and Glare projects.
+
+The API it exposes is not stable, has some shortcomings, and is not a
+general purpose interface. We would eventually like to change this,
+but for now using this library outside of Glance or Glare will not be
+supported by the core team.
+
* License: Apache License, Version 2.0
* Documentation: http://docs.openstack.org/developer/glance_store
* Source: http://git.openstack.org/cgit/openstack/glance_store