os-brick/README.rst
Flavio Percoco 29c2a8e016 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/0f70ae22bd907d16a1c07ec7dd7380b0\n'

Change-Id: Ibe0040b1491da61885e25fc3ac22a29459298170
2016-11-25 13:40:47 +01:00

49 lines
1.4 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/os-brick.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
===============================
brick
===============================
.. image:: https://img.shields.io/pypi/v/os-brick.svg
:target: https://pypi.python.org/pypi/os-brick/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/dm/os-brick.svg
:target: https://pypi.python.org/pypi/os-brick/
:alt: Downloads
OpenStack Cinder brick library for managing local volume attaches
Features
--------
* Discovery of volumes being attached to a host for many transport protocols.
* Removal of volumes from a host.
Hacking
-------
Hacking on brick requires python-gdbm (for Debian derived distributions),
Python 2.7 and Python 3.4. A recent tox is required, as is a recent virtualenv
(13.1.0 or newer).
If "tox -e py34" fails with the error "db type could not be determined", remove
the .testrepository/ directory and then run "tox -e py34".
For any other information, refer to the developer documents:
http://docs.openstack.org/developer/os-brick/index.html
OR refer to the parent project, Cinder:
http://docs.openstack.org/developer/cinder/
* License: Apache License, Version 2.0
* Source: http://git.openstack.org/cgit/openstack/os-brick
* Bugs: http://bugs.launchpad.net/os-brick