Add a more detailed README doc
Change-Id: I4864bfcbfa1860806a30c1c77a22bb0452202274
This commit is contained in:
parent
991f3b86e8
commit
86bc488722
39
README.rst
39
README.rst
@ -1,19 +1,30 @@
|
||||
==================
|
||||
python-moganclient
|
||||
==================
|
||||
==========================================
|
||||
Python bindings to the OpenStack Mogan API
|
||||
==========================================
|
||||
|
||||
Python client library for OpenStack Mogan project.
|
||||
.. image:: https://img.shields.io/pypi/v/python-moganclient.svg
|
||||
:target: https://pypi.python.org/pypi/python-moganclient/
|
||||
:alt: Latest Version
|
||||
|
||||
Please fill here a long description which must be at least 3 lines wrapped on
|
||||
80 cols, so that distribution package maintainers can use it in their packages.
|
||||
Note that this is a hard requirement.
|
||||
.. image:: https://img.shields.io/pypi/dm/python-moganclient.svg
|
||||
:target: https://pypi.python.org/pypi/python-moganclient/
|
||||
:alt: Downloads
|
||||
|
||||
This is a client library for Mogan built on the Mogan API. It provides a
|
||||
Python API (the ``moganclient`` module) and a OSC (the openstackclient CLI)
|
||||
command-line tool (``openstack baremetalcompute``).
|
||||
|
||||
* Free software: Apache license
|
||||
* Documentation: http://python-moganclient.readthedocs.io/
|
||||
* Source: http://git.openstack.org/cgit/openstack/python-moganclient
|
||||
* Bugs: http://bugs.launchpad.net/python-moganclient
|
||||
* `PyPi`_ - package installation
|
||||
* `Online Documentation`_
|
||||
* `Launchpad project`_ - release management
|
||||
* `Blueprints`_ - feature specifications
|
||||
* `Bugs`_ - issue tracking
|
||||
* `Source`_
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
* TODO
|
||||
.. _PyPi: https://pypi.python.org/pypi/python-moganclient
|
||||
.. _Online Documentation: http://python-moganclient.readthedocs.io/
|
||||
.. _Launchpad project: https://launchpad.net/python-moganclient
|
||||
.. _Blueprints: https://blueprints.launchpad.net/python-moganclient
|
||||
.. _Bugs: https://bugs.launchpad.net/python-moganclient
|
||||
.. _Source: https://git.openstack.org/cgit/openstack/python-moganclient
|
||||
|
Loading…
x
Reference in New Issue
Block a user