Refactor README to use Ansible Galaxy template

Template generated by `ansible-galaxy init`, as recommended in docs.

Change-Id: I8423e5b628b50feb0e16d28961d79d49d7bf82a6
Signed-off-by: Daniel Farrell <dfarrell@redhat.com>

diff --git a/README.markdown b/README.markdown
index 11d2da36a16e7e6859e6429e20cbd774db46a999..1d40c588792c2f95e7898354248ef5b37a9b8eed 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -3,3 +3,41 @@
 Ansible role for the [OpenDaylight SDN controller](http://www.opendaylight.org/project/technical-overview).
 
 **This project is new and under construction. See our [issue tracker](https://github.com/dfarrell07/ansible-opendaylight/issues) for detals.**
+
+## Requirements
+
+The OpenDaylight Ansible role handles the installation and configuration of all of its dependences.
+
+## Role Variables
+
+### Karaf Features
+
+To set extra Karaf features to be installed at OpenDaylight start time, pass them in a list to the `extra_features` param. The extra features you pass will typically be driven by the requirements of your ODL install. You'll almost certainly need to pass some.
+
+OpenDaylight normally installs a default set of Karaf features at boot. They are recommended, so the ODL Puppet mod defaults to installing them. This can be customized by overriding the `default_features` param. You shouldn't normally need to do so.
+
+## Dependencies
+
+The OpenDaylight Ansible role doesn't depend on any other Ansible roles.
+
+## Example Playbook
+
+The simple example playbook below would install and configure OpenDaylight using this role.
+
+```
+---
+- hosts: example_host
+  sudo: yes
+  roles:
+    - opendaylight
+```
+
+## License
+
+The OpenDaylight Ansible role is Open Sourced under a BSD two-clause license. Contributions encouraged!
+
+## Author Information
+
+Daniel Farrell of the OpenDaylight Integration Team is the main developer of this module.
+
+Please raise [issues](https://github.com/dfarrell07/ansible-opendaylight/issues) to ask questions, request features, report bugs or otherwise contribute. Please avoid 1-1 communication, as Open Source projects benefit from public, documented communication.