Commit 74adf74a5304c8fea5d28416e3382398a6a3d205

Stephen Moloney 2017-02-16T15:58:02

update docs

diff --git a/README.md b/README.md
index dd1ada0..6a784f1 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,7 @@ functions of the ***ex_ovh*** `API`.
 - [ ] Add queries for the remainder of the OVH API. (Webstorage CDN and Cloud are the only ones covered so far)
 - [ ] Basic examples to be added to readme of usage of the api.
 - [ ] Add macro for building queries.
+- [ ] Write the usage guide - more examples of using the API.
 
 
 #### Note 
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 765043d..22d3e99 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -117,13 +117,55 @@ end
 
 #### Example usages
 
-- First start the application `iex -S mix`
+- First start the application with the system environment variables available `source .env && iex -S mix`
 
 - Then try running some requests against the `API`
 
 
+#### Examples - Method 1 - Building the queries manually and sending the request (my preferred way)
 
-#### Some useful requests in the `OVH console` to see applications
 
-- `GET /me/api/application` -- returns a list of application ids.
-- `GET /me/api/application/{applicationId}` -- returns json with application key.
\ No newline at end of file
+- `GET /me`
+```
+%ExOvh.Query{headers: [], method: :get, params: %{}, service: :ovh, uri: "/me"} \
+|> MyApp.OvhClient.request!()
+```
+
+- `GET /me/api/application`
+```
+%ExOvh.Query{headers: [], method: :get, params: %{}, service: :ovh, uri: "/me/api/application"} \
+|> MyApp.OvhClient.request!()
+```
+
+- `GET /me/api/application/#{app_id}`
+```
+app_id = "0"
+%ExOvh.Query{headers: [], method: :get, params: %{}, service: :ovh, uri: "/me/api/application/#{app_id}"} \
+|> MyApp.OvhClient.request!()
+```
+
+- `GET /cloud/project/{serviceName}/storage`
+```
+service_name = "service_name" \
+%ExOvh.Query{headers: [], method: :get, params: %{}, service: :ovh, uri: "/cloud/project/#{service_name}/storage"} \
+MyApp.OvhClient.request!()
+```
+
+
+#### Examples - Method 2 - Build the query using provided helper functions and sending the request
+
+***Note:*** The Helper functions are listed under `Services`. Helper functions are only available currently for the
+`/Cloud` portion of the OVH API. Where other parts of the api need to be queried, just build the query manually
+using *Method 1* as above. Pull requests for helper functions for other parts of the OVH API are welcome.
+*Eventually, I would like to write a macro to create the queries.*
+
+- `GET /cloud/project/{serviceName}/storage`
+```
+ExOvh.Services.V1.Cloud.Cloudstorage.Query.get_containers(service_name) \
+|> ExOvh.request!()
+```
+
+
+#### Usage guide
+
+- For more usage examples see the usage guide or the [hex documentation]((https://github.com/stephenmoloney/ex_ovh/blob/master/docs/mix_task.md)
\ No newline at end of file