Adding Jeff Geerlings suggestions.

robertdebock · Oct 3, 2018 · d9842db · d9842db
1 parent 5f72b4b
commit d9842db
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/README.md.j2 b/README.md.j2
@@ -3,7 +3,19 @@
 
 [![Build Status](https://travis-ci.org/robertdebock/ansible-role-{{ role_name}}.svg?branch=master)](https://travis-ci.org/robertdebock/ansible-role-{{ role_name}})
 
-Provides {{ role_name }} for your system.
+The purpose of this role is to install and configure {{ role_name }} on your system.
+
+[Unit tests](https://travis-ci.org/robertdebock/ansible-role-{{ role_name }}) are done on every commit and periodically.
+
+If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-{{ role_name }}/issues)
+
+To test this role locally please use [Molecule](https://github.com/metacloud/molecule):
+```
+pip install molecule
+molecule test --scenario-name fedora-latest
+```
+There are many scenarios available, please have a look in the `molecule/` directory.
+
 
 Context
 --------