Initial commit

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9ba4477
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+A simple module to create hosts in [the Foreman][] via [Ansible][]
+
+Usage:
+
+    ansible-playbook --module-path . -c local -i localhost, example.yml
+
+The file example.yml has an example. You can augment this with a
+custom json template for parameters that aren't configurable (yet).
+
+Simple example:
+
+    - foremanhost: name=foo hostgroup=bar state=present api_user=foreman api_password=changeme api_url: https://127.0.0.1
+
+[the Foreman]: http://theforeman.org
+[Ansible]: http://ansible.com
\ No newline at end of file