spacing
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
diff --git a/README.md b/README.md
index 6a784f1..b16e74d 100644
--- a/README.md
+++ b/README.md
@@ -12,15 +12,14 @@ To use the Openstack components of the OVH API, see [Openstex](https://github.co
- Request functions to send Queries to the [Ovh Api](https://api.ovh.com/).
-
-
#### Getting started - Step 1: Generating the OVH `application key`, `application secret` and `consumer key`.
-- This may be done manually by going to `https://eu.api.ovh.com/createApp/` and following the directions outlined by `OVH` ath
+- This may be done manually by going to `https://eu.api.ovh.com/createApp/` and following the directions outlined by `OVH` at
[their first steps guide](https://api.ovh.com/g934.first_step_with_api).
- Alternatively, this may be achieved by running a mix task. This saves me a lot of time when generating a new application.
- [Documentation here](https://github.com/stephenmoloney/ex_ovh/blob/master/docs/mix_task.md)
+
+- [Documentation here](https://github.com/stephenmoloney/ex_ovh/blob/master/docs/mix_task.md)
#### Getting Started - Step 2: Generating the OVH client module for your elixir application
@@ -33,12 +32,54 @@ functions of the ***ex_ovh*** `API`.
#### Usage
-- Basic examples to be added to readme.
+#### Examples - Method 1 - Building the queries manually and sending the request (my preferred way)
+
+
+- `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!()
+```
-[See Hex Docs](https://hexdocs.pm/ex_ovh/0.2/api-reference.html)
+- `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!()
+```
+
+- For more information [See Hex Docs](https://hexdocs.pm/ex_ovh/0.2/api-reference.html)
#### Contributing
+
- Pull requests welcome.
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 22d3e99..48d4706 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -168,4 +168,4 @@ ExOvh.Services.V1.Cloud.Cloudstorage.Query.get_containers(service_name) \
#### 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
+- 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