From d830767711531a78800610483fed49c38a16d20d Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 21 Apr 2015 15:38:25 +0000 Subject: [PATCH] Update README to work with release tools 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 --- README.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ea8e44c..0fc449a 100644 --- a/README.rst +++ b/README.rst @@ -1 +1,14 @@ -This is the client API library for Neutron. +Python bindings to the Neutron API +================================== + +This is a client library for Neutron built on the Neutron API. It +provides a Python API (the ``neutronclient`` module) and a command-line tool +(``neutron``). + +Development takes place via the usual OpenStack processes as outlined in the +`developer guide `_. + +* License: Apache License, Version 2.0 +* Documentation: http://docs.openstack.org/developer/python-neutronclient +* Source: http://git.openstack.org/cgit/openstack/python-neutronclient +* Bugs: http://bugs.launchpad.net/python-neutronclient