trove/README.rst
Flavio Percoco 91430cdb96 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/4ccf1cc6e531bb50e78cb4d64dfe1065\n'

Change-Id: I7807742c785fbc7d1907f206f657683b8988c5a0
Partial-Bug: 1644851
2016-12-01 22:07:32 +00:00

36 lines
908 B
ReStructuredText

=====
Trove
=====
.. image:: http://governance.openstack.org/badges/trove.svg
:target: http://governance.openstack.org/reference/tags/index.html
Trove is Database as a Service for OpenStack.
Getting Started
---------------
If you'd like to run from the master branch, you can clone the git repo:
git clone https://github.com/openstack/trove
* Wiki: https://wiki.openstack.org/wiki/Trove
* Developer Docs: http://docs.openstack.org/developer/trove
You can raise bugs here: https://bugs.launchpad.net/trove
Python client
-------------
https://git.openstack.org/cgit/openstack/python-troveclient
References
----------
* Installation docs:
http://docs.openstack.org/developer/trove/dev/install.html
* Manual installation docs:
http://docs.openstack.org/developer/trove/dev/manual_install.html
* Build guest image:
http://docs.openstack.org/developer/trove/dev/building_guest_images.html