diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d449f5 --- /dev/null +++ b/README.md @@ -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 : 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 +