Create README.md

pull/3/head
Antoine Leveugle 2014-04-17 20:13:09 +02:00
parent 01f8a1f689
commit ca60dc6686
1 changed files with 28 additions and 0 deletions

28
README.md Normal file
View File

@ -0,0 +1,28 @@
ovhApiBashClient
================
A bash client for OVH API (https://api.ovh.com/)
Initialize
----------
In order to create a new OVH API application, run :
./ovhApiBashClient.sh --initApp
Usage
-----
To make a basic call on GET /me just run :
./ovhApiBashClient.sh
Options
-------
Possible arguments are:
--url <url> : the API URL to call, for example /domains (default is /me)
--method <method> : the HTTP method to use, for example POST (default is GET)
--data <JSON data> : the data body to send with the request
--init : to initialize the consumer key
--initApp : to initialize the API application