Commit b6bd39376f3560470a22a9bc805bf4c24aeb75a7

Stephen Moloney 2016-06-09T14:43:22

tidy up docs

diff --git a/README.md b/README.md
index 7a10cce..9342ec6 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # ExOvh [![Build Status](https://travis-ci.org/stephenmoloney/ex_ovh.svg)](https://travis-ci.org/stephenmoloney/ex_ovh) [![Hex Version](http://img.shields.io/hexpm/v/ex_ovh.svg?style=flat)](https://hex.pm/packages/ex_ovh) [![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/ex_ovh)
 
-ExOvh is an helper library in the [elixir language](http://elixir-lang.org/) for the [Ovh Api](https://api.ovh.com/).
+ExOvh is an helper library for the [elixir language](http://elixir-lang.org/) for the [Ovh Api](https://api.ovh.com/).
 
 To use the Openstack components of the OVH API, see [Openstex](https://github.com/stephenmoloney/openstex)
 
@@ -9,23 +9,31 @@ To use the Openstack components of the OVH API, see [Openstex](https://github.co
 
 - Config supervised Agent running in the background which stores frequently accessed authentication information.
 - Query modules for making building requests to the [Ovh Api](https://api.ovh.com/).
-- `request` functions to send Queries to the [Ovh Api](https://api.ovh.com/).
+- request functions to send Queries to the [Ovh Api](https://api.ovh.com/).
 
 
 ## Documentation
 
-- [hex package manager](https://hexdocs.pm/ex_hubic/api-reference.html).
+- [See Hex Docs](https://hexdocs.pm/ex_ovh)
 
 ## Getting started
-  
-- For setting a single `ExOvh` client, see [getting started basic](https://github.com/stephenmoloney/ex_ovh/docs/getting_started_basic.md.html)
-and [mix_task_basic.md](https://github.com/stephenmoloney/ex_ovh/docs/getting_started_basic.md).
-- For setting up multiple clients, see [getting started advanced](https://hexdocs.pm/ex_ovh/doc/getting_started_advanced.md) and
-[mix_task_advanced.md](https://github.com/stephenmoloney/ex_ovh/docs/getting_started_advanced.md).
 
-## Examples
+#### Example (1)
 
-- to be added
+| Step 1: Generating the OVH application | Step 2: Setup |
+|---|---|
+| [Mix Task](https://github.com/stephenmoloney/ex_ovh/docs/mix_task_basic.md) (optional) | [Setting up the Client](https://github.com/stephenmoloney/ex_ovh/docs/getting_started_basic.md) |
+
+#### Example (2) - Recommended way of getting started
+
+| Step 1: Generating the OVH application | Step 2: Setup |
+|---|---|
+| [Mix Task](https://github.com/stephenmoloney/ex_ovh/docs/mix_task_advanced.md) (optional) | [Setting up Clients](https://hexdocs.pm/ex_ovh/doc/getting_started_advanced.md) |
+
+
+## Usage
+
+- To be added
 
 
 ## Issues, Bug Reports, Feature Requests, Suggestions, Guidance, etc
diff --git a/docs/getting_started_advanced.md b/docs/getting_started_advanced.md
index 3ba78c9..5ee6313 100644
--- a/docs/getting_started_advanced.md
+++ b/docs/getting_started_advanced.md
@@ -6,7 +6,7 @@
 
 ```elixir
 defp deps() do
-  [{:ex_ovh, "~> 0.0.1"}]
+  [{:ex_ovh, "~> 0.1.0"}]
 end
 ```
 
@@ -17,7 +17,7 @@ end
 - Create an OVH account at [OVH](https://www.ovh.com/us/)
 
 - Create an API application at the [OVH API page](https://eu.api.ovh.com/createApp/). Follow the
-  steps outlined by OVH there. Alternatively, there is a [mix task](https://hexdocs.pm/ex_hubic/doc/mix_task_advanced.md.html) which can help 
+  steps outlined by OVH there. Alternatively, there is a [mix task](https://github.com/stephenmoloney/ex_ovh/docs/mix_task_advanced.md) which can help
   generate the OVH application.
   
 - Add the configuration settings for the OVH application to your project `config.exs`.
diff --git a/docs/getting_started_basic.md b/docs/getting_started_basic.md
index 8c8bb76..aeecc6f 100644
--- a/docs/getting_started_basic.md
+++ b/docs/getting_started_basic.md
@@ -9,7 +9,7 @@ on a given server.
 
 ```elixir
 defp deps() do
-  [{:ex_ovh, "~> 0.0.1"}]
+  [{:ex_ovh, "~> 0.1.0"}]
 end
 ```
 
@@ -20,7 +20,7 @@ end
 - Create an OVH account at [OVH](https://www.ovh.com/us/)
 
 - Create an API application at the [OVH API page](https://eu.api.ovh.com/createApp/). Follow the
-  steps outlined by OVH there. Alternatively, there is a [mix task](https://hexdocs.pm/ex_hubic/doc/mix_task_advanced.md.html) which can help 
+  steps outlined by OVH there. Alternatively, there is a [mix task](https://github.com/stephenmoloney/ex_ovh/docs/mix_task_basic.md) which can help
   generate the OVH application.
   
 - Add the configuration settings for the OVH application to your project `config.exs`.
diff --git a/docs/mix_task_advanced.md b/docs/mix_task_advanced.md
index aaf3183..16a985a 100644
--- a/docs/mix_task_advanced.md
+++ b/docs/mix_task_advanced.md
@@ -2,12 +2,19 @@
 
 ## Generate client config
 
-The hubic mix task makes requests to the Hubic Api on the user's behalf to get details 
-such as the referesh token and then generates a configuration which can copied and pasted into `config.exs`.
+The ovh mix task makes requests to the OVH API on the user's behalf to generate an OVH application.
+
+- The mix task:
+
+  1. Creates an application on the user's behalf by sending http requests using the user's username and password credentials.
+  2. Gets a consumer key and validation url.
+  3. Validates the validation url on the user's behalf by sending http requests using the user's username and password credentials.
+  4. Adds the application key, application secret and associated consumer key to the environment configuration.
 
 The environment variables generated by the task are automatically save to a `.env` file. It is best to ensure that this file is outside
 version control.
 
+
 **Shell Input:**
 
 ```shell