Merge pull request #76 from paulrbr-fl/add-license

Prepare for open-source: adding license and clarification in README

2 files changed, 23 insertions, 6 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..9be8747
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,7 @@
+Copyright (c) 2020 Fretlink S.A.S
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
index eaddbd5..499dced 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ Requirements
 
 This role requires [`clever-tools`](https://github.com/CleverCloud/clever-tools) CLI version `2.6.1` or higher.
 
-If you want to configure this role with [Dhall](https://dhall-lang.org/) instead of YAML, the dhall bindings defined in the `dhall/` directory will need Dhall version `1.26.0` or higher.
+If you want to configure this role with [Dhall](https://dhall-lang.org/) instead of YAML, the role publishes dhall bindings defined in the `dhall/package.dhall` file. These bindings will need Dhall version `1.26.0` or higher.
 
 Role Variables
 --------------
@@ -37,11 +37,11 @@ Variables for the application:
 - `clever_service_dependencies`: a list of the service dependencies needed by the application (each service being a dict containing either an `app_id` field, or an `addon_id` field), optional.<br/>
   Example: `[{ addon_id: addon_00000000-0000-0000-0000-000000000000 }, { app_id: app_00000000-0000-0000-0000-000000000000 }]`
 
-Variables specific to deployment, defaults should be fine:
+Variables **specific to deployment**, defaults should be fine:
 
+- `clever_app_root`: Path of the application to deploy, default to `app_root` if defined or `"{{ playbook_dir }}/.."` otherwise. I.e. the default behaviour will work fine if you define a playbook using this role within a directory (e.g. `deployment/` located at the root of the application.
 - `clever_cli_version`: Version of clever cli tools, default to `2.6.1`.
 - `clever_user_path`: Path relative to ansible_user home dir where cli tools and helpers are installed default to `.local/bin`.
-- `clever_app_root`: Path of the application to deploy, default to `app_root` if defined or `"{{ playbook_dir }}/.."` otherwise. I.e. the default behavior will work fine if you define a playbook using this role in a one level deep directory (e.g. `deployment/`) of the root of the application.
 - `clever_app_confdir`: Path where to store clever cloud data specific to this application, default to `"{{ clever_app_root }}/.clever_cloud"`
 - `clever_login_file`: Path to store login information. Default to `"{{ clever_app_confdir }}/login"`.
 - `clever_restart_only`: set to `true` to skip any deployment related tasks (domain, scaling, env, deploy, …) and only restart the application. Optional.
@@ -72,7 +72,7 @@ None
 Example Playbook
 ----------------
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+This is the most basic usage of the role by specifying at least the clever app id and a clever token & secret pair.
 
     - hosts: localhost
       roles:
@@ -82,6 +82,16 @@ Including an example of how to use your role (for instance, with variables passe
              clever_token: "{{ vault_clever_token }}",
              clever_secret: "{{ vault_clever_secret}}"
 
+If you only need a task to restart your clever application, this would be enough:
+
+    - hosts: localhost
+      roles:
+         - role: fretlink.clever,
+           vars:
+             clever_app: app_00000000-0000-0000-0000-000000000000,
+             clever_token: "{{ vault_clever_token }}",
+             clever_secret: "{{ vault_clever_secret}}"
+             clever_restart_only: true
 
 Tests
 ----
@@ -91,9 +101,9 @@ The role is tested with automated continuous integration on Travis. Please check
 License
 -------
 
-BSD
+MIT (see LICENSE file for details)
 
 Author Information
 ------------------
 
-Developped at Fretlink (https://www.fretlink.com)
+Developed at [Fretlink](https://tech.fretlink.com)