diff --git a/README.md b/README.md index e83bf95..a3cfc1a 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,37 @@ A bash client for OVH API (https://api.ovh.com/) Initialize ---------- +### Create an OVH API Application + In order to create a new OVH API application, run: ``` ./ovhApiBashClient.sh --initApp ``` +### Create a Consumer Key + +In order to create a new consumer key, run: +``` + ./ovhApiBashClient.sh --init +``` + +Options +------- + +Possible arguments are: +``` + --url : the API URL to call, for example /domains (default is /me) + --method : the HTTP method to use, for example POST (default is GET) + --data : the data body to send with the request + --init : to initialize the consumer key + --initApp : to initialize the API application +``` + Usage ----- +### Just some examples: + To make a basic call on GET /me just run: ``` ./ovhApiBashClient.sh @@ -29,15 +52,3 @@ To activate the monitoring on your dedicated server, run: ./ovhApiBashClient.sh --method PUT --url "/dedicated/server/ns00000.ovh.net" --data '{"monitoring": true}' ``` - -Options -------- - -Possible arguments are: -``` - --url : the API URL to call, for example /domains (default is /me) - --method : the HTTP method to use, for example POST (default is GET) - --data : the data body to send with the request - --init : to initialize the consumer key - --initApp : to initialize the API application -```