Merge pull request #9 from ovh/readme-improvements

Readme improvements

Author: amstuta

README.md

@@ -11,50 +11,32 @@
 # Table of Contents
 
 - [Installation](#installation)
-- [Build](#build)
 - [Usage](#usage)
-    - [Login](#login)
-    - [Configuration](#configuration)
-    - [Generate Shell Completion](#generate-shell-completion)
+    - [Authenticating the CLI](#authenticating-the-cli)
     - [Examples](#examples)
-- [Get the sources](#get-the-sources)
+- [Generate Shell Completion](#generate-shell-completion)
+- [Contributing](#contributing)
+    - [Build](#build)
     - [Run the tests](#run-the-tests)
+    - [Our awesome contributors](#our-awesome-contributors)
 - [Related links](#related-links)
 
 # Installation
 
 1. Download [latest release](https://github.com/ovh/ovhcloud-cli/releases/latest)
 2. Untar / unzip the archive
 3. Add the containing folder to your `PATH` environment variable
-4. Check the [CLI documentation](./doc/ovhcloud.md)
 
-# Build
+# Usage
 
 ```bash
-# Build the OVHcloud cli
-$ make build
-
-# Cross-compile for other targets in ./dist
-$ make release-snapshot
-
-# Optionally, you can compile a WASM binary
-$ make wasm
+$ ovhcloud [command] {subcommands} {parameters/flags}
 ```
 
-# Usage
-
-Checkout the [full documentation](./doc/ovhcloud.md)
-
-Invoke the binary `ovhcloud[.exe]` or run `go run ./cmd/ovhcloud`.
+Checkout the [full documentation](./doc/ovhcloud.md).
 
+Available commands:
 ```
-$ ovhcloud --help
-CLI to manage your OVHcloud services
-
-Usage:
-  ovhcloud [command]
-
-Available Commands:
   account                          Manage your account
   alldom                           Retrieve information and manage your AllDom services
   baremetal                        Retrieve information and manage your baremetal services
@@ -100,29 +82,27 @@ Available Commands:
   vrackservices                    Retrieve information and manage your vRackServices services
   webhosting                       Retrieve information and manage your WebHosting services
   xdsl                             Retrieve information and manage your XDSL services
+```
+
+Global options:
 
-Flags:
+```
   -d, --debug           Activate debug mode (will log all HTTP requests details)
   -f, --format string   Output value according to given format (expression using gval format)
   -h, --help            help for ovhcloud
   -e, --ignore-errors   Ignore errors in API calls when it is not fatal to the execution
   -i, --interactive     Interactive output
   -j, --json            Output in JSON
   -y, --yaml            Output in YAML
-
-Use "ovhcloud [command] --help" for more information about a command.
 ```
 
-## Login
+## Authenticating the CLI
 
-```bash
-# Log in and create API credentials (interactive)
-$ ovhcloud login
-```
+OVHcloud CLI requires authentication to be able to make API calls. There are several ways to define your credentials.
 
-Check out the [authentication page](./doc/authentication.md) for further information about the authentication means.
+Check out the [authentication page](./doc/authentication.md) for further information about the configuration and the authentication means.
 
-## Configuration
+* Using a configuration file:
 
 Default settings can be set using a configuration file named `.ovh.conf` and located in your `${HOME}` directory.
 
@@ -140,20 +120,21 @@ client_secret = <OAuth 2.0 client secret>
 default_cloud_project = <public cloud project ID>
 ```
 
-## Generate Shell Completion
+* Using environment variables:
 
 ```bash
-# Bash
-eval "$(./ovhcloud completion bash)"
-# Zsh
-eval "$(./ovhcloud completion zsh)"
-# Fish
-./ovhcloud completion fish | source
-# PowerShell
-./ovhcloud completion powershell | Out-String | Invoke-Expression
+OVH_ENDPOINT=ovh-eu
+OVH_APPLICATION_KEY=xxx
+OVH_APPLICATION_SECRET=xxx
+OVH_CONSUMER_KEY=xxx
+OVH_CLOUD_PROJECT_SERVICE=<public cloud project ID> 
 ```
 
-Add the appropriate line to your shell’s startup file (`~/.bashrc`, `~/.zshrc`, etc.) to enable persistent autocompletion.
+* Interactive login:
+```bash
+# Log in and create API credentials (interactive)
+ovhcloud login
+```
 
 ## Examples
 
@@ -164,24 +145,53 @@ Add the appropriate line to your shell’s startup file (`~/.bashrc`, `~/.zshrc`
 | Fetch details of a single VPS in JSON | `ovhcloud vps get <service_id> --json`          |
 | Reinstall a baremetal interactively   | `ovhcloud baremetal reinstall <id> --editor`    |
 
-# Get the sources
+# Generate Shell Completion
 
 ```bash
-$ git clone https://github.com/ovh/ovhcloud-cli.git
+# Bash
+eval "$(./ovhcloud completion bash)"
+# Zsh
+eval "$(./ovhcloud completion zsh)"
+# Fish
+./ovhcloud completion fish | source
+# PowerShell
+./ovhcloud completion powershell | Out-String | Invoke-Expression
 ```
- 
-You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you!
+
+Add the appropriate line to your shell’s startup file (`~/.bashrc`, `~/.zshrc`, etc.) to enable persistent autocompletion.
+
+# Contributing
+
+You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you, there are no small contributions!
 
 Have a look in [CONTRIBUTING.md](https://github.com/ovh/ovhcloud-cli/blob/master/CONTRIBUTING.md)
 
+## Build
+
+```bash
+# Build the OVHcloud cli
+make build
+
+# Cross-compile for other targets in ./dist
+make release-snapshot
+
+# Optionally, you can compile a WASM binary
+make wasm
+```
+
 ## Run the tests
 
 ```bash
-$ make test
+make test
 ```
 
+## Our awesome contributors
+
+<a href="https://github.com/ovh/ovhcloud-cli/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ovh/ovhcloud-cli" />
+</a>
+
 # Related links
 
- * Contribute: https://github.com/ovh/ovhcloud-cli/blob/master/CONTRIBUTING.md
  * Report bugs: https://github.com/ovh/ovhcloud-cli/issues
- * Get latest version: https://github.com/ovh/ovhcloud-cli/releases/latest
+ * Get latest version: https://github.com/ovh/ovhcloud-cli/releases/latest