Update README

This patch updates the README file to add links to documentation and
contact information.

Change-Id: Ia28c9fbd8ab7fb3c083259b2f85b5f04a702343f
This commit is contained in:
Major Hayden 2017-04-19 07:50:31 -05:00
parent cf4a71bfee
commit 95fb4b1983
2 changed files with 40 additions and 4 deletions

View File

@ -1,5 +1,5 @@
monitorstack
============
.. image:: doc/source/monitorstack-text.png
:alt: monitorstack text
.. list-table::
:stub-columns: 1
@ -12,6 +12,42 @@ monitorstack
.. |codecov| image:: https://img.shields.io/codecov/c/github/major/monitorstack.svg
:alt: Coverage Status
Monitoring plugins for OpenStack.
The monitorstack project provides a framework for writing monitoring plugins
that output data in various formats for different monitoring systems.
Developers can quickly add new monitoring plugins (along with tests) without
worrying about how to format the data.
*Work in progress.*
For more details, including how to install/configure, a usage guide, and a
developer guide, review the `monitorstack documentation`_.
.. _monitorstack documentation: https://docs.openstack.org/developer/monitorstack/
Requirements
------------
Python 2.7 or higher is required for monitorstack.
Each commit is tested against Python 2.7, 3.3, 3.4, 3.5, and pypy.
License
-------
Apache 2.0
Community
---------
The monitorstack project is managed by the `OpenStack-Ansible community`_, but
it can be used with or without OpenStack-Ansible.
Contact information:
* ``#openstack-ansible`` on Freenode IRC
* `Launchpad Bugs`_
* Send email to ``openstack-dev@lists.openstack.org`` with
``[openstack-ansible][monitorstack]`` in the subject line.
.. _OpenStack-Ansible community: https://wiki.openstack.org/wiki/OpenStackAnsible
.. _Launchpad Bugs: https://bugs.launchpad.net/openstack-ansible

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB