summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorSergey Lukjanov <slukjanov@mirantis.com>2014-03-18 01:40:05 +0400
committerSergey Lukjanov <slukjanov@mirantis.com>2014-03-18 01:40:05 +0400
commitca3a9f9ece7218a31760752c42ff6b4a232c0a8f (patch)
tree8bf2e3d63e7d80b836705752b7f32b5c6ed1f187 /README.rst
parent184917ba795cd72726b45473ef7e951889ca370b (diff)
downloadpython-saharaclient-ca3a9f9ece7218a31760752c42ff6b4a232c0a8f.tar.gz
Add README file
Change-Id: I51fecc5fb26ca071b8dcda9c44f4b69934b0c854
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index e69de29..e454696 100644
--- a/README.rst
+++ b/README.rst
@@ -0,0 +1,19 @@
+Python bindings to the OpenStack Sahara API
+===========================================
+
+This is a client for the OpenStack Sahara API. There's a Python API (the
+``saharaclient`` module), and a command-line script (``sahara``). Each
+implements the OpenStack Sahara API. You can find documentation for both
+Python bandings and CLI in `Docs`_.
+
+The project is hosted on `Launchpad`_, where bugs can be filed. The code is
+hosted on `Github`_. Patches must be submitted using `Gerrit`_, *not* Github
+pull requests.
+
+.. _Github: https://github.com/openstack/python-saharaclient
+.. _Launchpad: https://launchpad.net/python-saharaclient
+.. _Gerrit: http://wiki.openstack.org/GerritWorkflow
+.. _Docs: http://docs.openstack.org/developer/python-saharaclient/
+
+python-saharaclient is licensed under the Apache License like the rest of
+OpenStack.