summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2015-03-17 18:05:45 -0400
committerSteve Martinelli <stevemar@ca.ibm.com>2015-03-17 18:05:45 -0400
commitb697115558957331eec9c2f5e60c2e4919a2de27 (patch)
treeba57ff3435eec4d41efa85fbf38eb2b732e84099
parent393782a5444be1464005ca65148636e71c1b3bd1 (diff)
downloadpycadf-b697115558957331eec9c2f5e60c2e4919a2de27.tar.gz
update README.rst to include additional links
The current rendering of README.rst on pypi is a bit lacking, source: https://pypi.python.org/pypi/pycadf We should include links to blueprints, source, release management. Also remove dead references to doc/source and CONTRIBUTING.rst Change-Id: Id1c12487fae1c7335b5eb267a476934ec65dff49
-rw-r--r--README.rst21
1 files changed, 12 insertions, 9 deletions
diff --git a/README.rst b/README.rst
index a692385..5374485 100644
--- a/README.rst
+++ b/README.rst
@@ -7,13 +7,16 @@ Federation <http://www.dmtf.org/standards/cadf>`_ specification, primarily for
use by OpenStack. The goal is to establish strict expectations about what
auditors can expect from audit notifications.
-Developer documentation, the source of which is in ``doc/source/``, is
-published at:
+* `PyPi`_ - package installation
+* `Online Documentation`_
+* `Launchpad project`_ - release management
+* `Blueprints`_ - feature specifications
+* `Bugs`_ - issue tracking
+* `Source`_
- http://docs.openstack.org/developer/pycadf
-
-Bugs and feature requests are tracked on Launchpad at:
-
- https://bugs.launchpad.net/pycadf
-
-For information on contributing, see ``CONTRIBUTING.rst``.
+.. _PyPi: https://pypi.python.org/pypi/pycadf
+.. _Online Documentation: http://docs.openstack.org/developer/pycadf/
+.. _Launchpad project: https://launchpad.net/pycadf
+.. _Blueprints: https://blueprints.launchpad.net/pycadf
+.. _Bugs: https://bugs.launchpad.net/pycadf
+.. _Source: https://git.openstack.org/cgit/openstack/pycadf