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
This commit is contained in:
Doug Hellmann 2015-04-21 15:35:47 +00:00
parent 622480a31a
commit f16d9de48c
3 changed files with 15 additions and 5 deletions

View File

@ -1,4 +0,0 @@
python-magnumclient
===================
A python language binding for magnum

14
README.rst Normal file
View File

@ -0,0 +1,14 @@
Python bindings to the Magnum API
=================================
This is a client library for Magnum built on the Magnum API. It
provides a Python API (the ``magnumclient`` module) and a command-line
tool (``magnum``).
Development takes place via the usual OpenStack processes as outlined
in the `developer guide
<http://docs.openstack.org/infra/manual/developers.html>`_.
* License: Apache License, Version 2.0
* Source: http://git.openstack.org/cgit/openstack/python-magnumclient
* Bugs: http://bugs.launchpad.net/python-magnumclient

View File

@ -2,7 +2,7 @@
name = python-magnumclient
summary = Client library for Magnum API
description-file =
README.md
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://www.openstack.org/