summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2015-04-21 15:07:07 +0000
committerDoug Hellmann <doug@doughellmann.com>2015-04-21 15:07:07 +0000
commit39d8b54d785bafd550a94b3d396ead8911557cfc (patch)
tree605c09d473187dca6fa97e175d01d146368c35d1 /README.rst
parented808de13f64bb53cb182308f58554726b5e0553 (diff)
downloadpython-designateclient-39d8b54d785bafd550a94b3d396ead8911557cfc.tar.gz
Update README to work with release tools1.2.0
The README file needs to have links to the project documentation and bug tracker in a parsable format in order for some of the release tools scripts to work (particularly the one that prints the release note email). Change-Id: I37e0acc5ed8e1af565359290fa622456901c735e
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index e69de29..204a9a6 100644
--- a/README.rst
+++ b/README.rst
@@ -0,0 +1,17 @@
+Python bindings to the Designate API
+=====================================
+
+This is a client library for Designate built on the Designate API. It
+provides a Python API (the ``designateclient`` module) and a command-line tool
+(``designate``).
+
+Development takes place via the usual OpenStack processes as outlined in the
+`developer guide <http://docs.openstack.org/infra/manual/developers.html>`_. The master
+repository is in `Git <http://git.openstack.org/cgit/openstack/python-designateclient>`_.
+
+See release notes and more at `<http://docs.openstack.org/developer/python-designateclient/>`_.
+
+* License: Apache License, Version 2.0
+* Documentation: http://docs.openstack.org/developer/python-designateclient
+* Source: http://git.openstack.org/cgit/openstack/python-designateclient
+* Bugs: http://bugs.launchpad.net/python-designateclient