Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dnaeon committed Apr 12, 2015
1 parent 32b176e commit 3e6d0d7
Showing 1 changed file with 30 additions and 12 deletions.
42 changes: 30 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,47 @@
PVC - Python vSphere Client with a dialog(1) interface
======================================================
Python vSphere Client with a dialog(1) interface
================================================

.. image:: docs/images/pvc-screenshot.jpg
PVC is an interactive text-mode VMware vSphere Client with a
`dialog(1)`_ interface for GNU/Linux systems built on top of the
`pyVmomi`_ VMware vSphere API Python bindings.

Using PVC allows you to quickly navigate in your VMware vSphere
environment and perform common tasks against various VMware vSphere
Managed Entities.

TODO: Document me
PVC is Open Source and licensed under the `BSD License`_.

.. image:: docs/images/pvc-screenshot.jpg

.. note::
Status
======

PVC is a my pet project and is in early pre-alpha stage.
Things could break and cause damage, use it at your own risk!
Experimental. PVC is in early development stage. Using PVC in a
production environment is not (yet) recommended.

Contributions
=============

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

Documentation
=============

TODO: Document me
The online documentation of PVC can be found at the link below:

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

At the above link you can also find example screenshots of using
PVC in a VMware vSphere environment.

Bugs
====

Probably. If you experience a bug issue, please report it to the
`PVC issue tracker on Github <https://github.com/dnaeon/pvc/issues>`_.
PVC issue tracker on `Github`_.

.. _`dialog(1)`: http://invisible-island.net/dialog/
.. _`pyVmomi`: https://github.com/vmware/pyvmomi
.. _`BSD License`: http://opensource.org/licenses/BSD-2-Clause
.. _`Github`: https://github.com/dnaeon/pvc

0 comments on commit 3e6d0d7

Please sign in to comment.