Skip to content

Commit

Permalink
README.md -> README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
dnaeon committed Sep 14, 2014
1 parent 78fbbeb commit c76ec16
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md → README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
## vPoller - Distributed vSphere API Proxy
vPoller - Distributed VMware vSphere API Proxy
==============================================

vPoller is a distributed VMware vSphere API Proxy, designed for
discovering and polling of vSphere objects.

It uses the [VMware vSphere API](https://www.vmware.com/support/developer/vc-sdk/)
It uses the `VMware vSphere API <https://www.vmware.com/support/developer/vc-sdk/>`_
in order to perform discovery and polling of vSphere objects.

vPoller uses the [ZeroMQ messaging library](http://zeromq.org/) for
vPoller uses the `ZeroMQ messaging library <http://zeromq.org/>`_ for
distributing tasks to workers and load balancing of client requests.

vPoller can be integrated with other systems, which require access to
Expand All @@ -17,22 +18,27 @@ monitoring systems as part of the discovery and polling process
in order to provide monitoring of your VMware vSphere environment.

vPoller has been tested with VMware vSphere 5.x and with very limited
testing on vSphere 4.x
testing on vSphere 4.x.

vPoller is Open Source and licensed under the [BSD License](http://opensource.org/licenses/BSD-2-Clause).
vPoller is Open Source and licensed under the
`BSD License <http://opensource.org/licenses/BSD-2-Clause`_.

## Contributions
Contributions
=============

vPoller is hosted on Github. Please contribute by reporting issues,
suggesting features or by sending patches using pull requests.
vPoller is hosted on `Github <https://github.com/dnaeon/py-vpoller>`_.
Please contribute by reporting issues, suggesting features or by
sending patches using pull requests.

## Documentation
Documentation
=============

The online documentation of vPoller can be found on the link below:

* http://vpoller.readthedocs.org/en/latest/

## Bugs
Bugs
====

Probably. If you experience a bug issue, please report it to the
[vPoller issue tracker on Github](https://github.com/dnaeon/py-vpoller/issues).
`vPoller issue tracker on Github <https://github.com/dnaeon/py-vpoller/issues>`_.

0 comments on commit c76ec16

Please sign in to comment.