diff --git a/README.rst b/README.rst index eff6bb5..5139c74 100644 --- a/README.rst +++ b/README.rst @@ -2,17 +2,27 @@ VirtualBMC ========== +Team and repository tags +------------------------ + +.. image:: https://governance.openstack.org/tc/badges/virtualbmc.svg + :target: https://governance.openstack.org/tc/reference/tags/index.html + +Overview +-------- + A virtual BMC for controlling virtual machines using IPMI commands. Installation ------------- +~~~~~~~~~~~~ .. code-block:: bash pip install virtualbmc + Supported IPMI commands ------------------------ +~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: bash @@ -28,11 +38,18 @@ Supported IPMI commands # Get the current boot device ipmitool -I lanplus -U admin -P password -H 127.0.0.1 chassis bootparam get 5 -Team and repository tags ------------------------- +Project resources +~~~~~~~~~~~~~~~~~ -.. image:: https://governance.openstack.org/tc/badges/virtualbmc.svg - :target: https://governance.openstack.org/tc/reference/tags/index.html +* Documentation: https://docs.openstack.org/virtualbmc/latest +* Source: https://git.openstack.org/cgit/openstack/virtualbmc +* Bugs: https://storyboard.openstack.org/#!/project/openstack/virtualbmc +* Release Notes: https://docs.openstack.org/releasenotes/virtualbmc/ -.. Change things from this point on +Project status, bugs, and requests for feature enhancements (RFEs) are tracked +in StoryBoard: +https://storyboard.openstack.org/#!/project/openstack/virtualbmc + +For information on how to contribute to VirtualBMC, see +https://docs.openstack.org/virtualbmc/latest/contributor