update readme

- update readme format to .md style
- change a few things
- remove short links
This commit is contained in:
Devananda van der Veen
2015-03-25 15:23:00 -07:00
parent 3d77266246
commit 45cc6c59cd

View File

@@ -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) <div data-long-uri="https://github.com/devananda/python-redfish"></div>
- **repo zip archive** - Shortened URL (http://git.io/hbj9) <div data-long-uri="https://github.com/devananda/python-redfish/zipball/master"></div>
- **repo tar archive** - Shortened URL (http://git.io/hbhp) <div data-long-uri="https://github.com/devananda/python-redfish/tarball/master"></div>
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.