v0.2.0 - rename set_locale to locale_config, add test_connection.yml playbook and update READMEs

README.md

@@ -1,4 +1,11 @@
-# Ansible Collection - dede.common
+# Ansible Collection - `dede.common`
+```
+     _          _                                                 
+  __| | ___  __| | ___   ___ ___  _ __ ___  _ __ ___   ___  _ __  
+ / _` |/ _ \/ _` |/ _ \ / __/ _ \| '_ ` _ \| '_ ` _ \ / _ \| '_ \ 
+| (_| |  __/ (_| |  __/| (_| (_) | | | | | | | | | | | (_) | | | |
+ \__,_|\___|\__,_|\___(_)___\___/|_| |_| |_|_| |_| |_|\___/|_| |_|
+```
 
 this ansible collection primarily aims to provide common roles that i've been building
 for either my home or the wululu web network and systems.  
@@ -8,17 +15,25 @@ please mind that everything in this collection mainly focuses debian as a server
 thus i will not add features specific to other operating systems unless i really need to.  
 if you have any questions or suggestions feel free to get in touch with me.
 
-## roles
+## contents
 
-* **test** – a simple role to test ansible or just this collection  
-  it will run a debug task printing 'hello world'
-* **config_locale** – role to configure system locale and language settings  
-  you should set `system_locale` and `system_language` if you want to deviate from the default:  
-  ```
-  system_locale: 'de_DE.UTF-8'
-  system_language: 'en_US.UTF-8'
-  ```
-* **docker** – a docker install role that can install docker-ce engine in two ways:  
-  1. from the official docker repository (recommended by docker)
-  2. from your distribution
-  you can switch to the distribution method by setting `docker_use_dist_repo` to `true` (defaults to `false`).
+### roles
+* **test** – a simple test role which runs a `debug` task printing 'hello world'
+* **locale_config** – role to configure system locale and language settings [🠞README](roles/locale_config/README.md)
+* **docker** – a docker install role to install docker-ce engine [🠞README](roles/docker/README.md)
+
+### playbooks
+* **test_connection.yml** – a playbook to test ansible and connectivity by running the `test` and the role 
+
+## usage
+to use a **playbook** provided with this collection you can use `import_playbook`:
+```yaml
+- ansible.builtin.import_playbook: dede.common.test_connection.yml
+```
+
+to use a **role** provided with this collection just reference it using the collection name as a prefix:  
+```yaml
+- hosts: all
+  roles:
+    - dede.common.test
+```