add ssh_authorize_host implementationHEADmain

1 files changed, 13 insertions, 8 deletions

diff --git a/README.md b/README.md
index ef191dc..1bd746f 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,15 @@
-# Ansible Role Template
+# Ansible authorize ssh host key role
 
-Description of what this role does.
+Role to authorize the host key of `ssh_hostname`.
+
+The role tries to authorize the host key globally at `/etc/ssh/ssh_known_hosts` or
+`~/.ssh/known_hosts` as fallback.
+
+## Variables
+
+* `ssh_hostname` the host to authorize
+* `use_host_ip_addresses` also authorize the IP addresses reported from DNS
+*
 
 ## Example Playbook
 
@@ -8,10 +17,6 @@ Description of what this role does.
 ---
 - hosts: host-pattern
   roles:
-    - this-role
+    - role: ssh_authorize_host
+      ssh_hostname: example.org
 ```
-
-## License
-
-This ansible role is licensed under the term of the GPLv3.  
-For further information see the `COPYING` file or [https://www.gnu.org/licenses/gpl-3.0.en.html](https://www.gnu.org/licenses/gpl-3.0.en.html).