diff --git a/README.rst b/README.rst index 73d5e99..cc74d0c 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,21 @@ -# python-redfish -This repository will be used to house the Redfish python library. This library will be used to help Python developers communicate with the [Redfish API](http://www.redfishspecification.org/). +python-redfish +============== -## Directory Structure -- **docs** - Links to documents discussing the Redfish Specification -- **python-redfish** - The python Redfish library +This repository will be used to house the Redfish python library. This library +will be used to help Python developers communicate with the Redfish API +(http://www.redfishspecification.org/). -## Requirements -To use the enclosed examples, you will need [Python 2.7](https://www.python.org/downloads/). Note that Python 2.7.9 enforces greater SSL verification requiring server certificates be installed. Parameters to relax the requirements are available in the library, but these configurations are discouraged due to security concerns. +Directory Structure +------------------- -## Shortcuts -- **repo webpage** - Shortened URL (http://git.io/hbp5)
-- **repo zip archive** - Shortened URL (http://git.io/hbj9)
-- **repo tar archive** - Shortened URL (http://git.io/hbhp)
+This project follows the same convention as OpenStack projects, eg. using pbr +for build and test automation. + +Requirements +------------ + +To use the enclosed examples, you will need Python 2.7 +(https://www.python.org/downloads/). Note that Python 2.7.9 enforces greater +SSL verification requiring server certificates be installed. Parameters to +relax the requirements are available in the library, but these configurations +are discouraged due to security concerns.