From 39e6b10feeae7ba99eeb964bf1b86314b2ece865 Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Tue, 10 Nov 2015 18:46:16 +0200
Subject: [PATCH] Fill README.
---
README.rst | 28 ++++++++++++++++------------
1 file changed, 16 insertions(+), 12 deletions(-)
diff --git a/README.rst b/README.rst
index 225dd44..cfa9ffc 100644
--- a/README.rst
+++ b/README.rst
@@ -1,38 +1,42 @@
-Role Name
-=========
+Ansible-Elasticsearch
+#####################
-A brief description of the role goes here.
+Ansible role to install Elasticsearch.
Requirements
------------
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+Debian Jessie.
Role Variables
--------------
-
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+::
+ elasticsearch_cors_domains: [ 'localhost', '*.{{ ansible_domain }}' ] # List
+ of domains that are enabled by CORS.
Dependencies
------------
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+None.
Example Playbook
----------------
-
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+::
- hosts: servers
roles:
- - { role: username.rolename, x: 42 }
+ - role: elasticsearch
+ elasticsearch_cors_domains: [ '*.example.com' ]
License
-------
-BSD
+MIT.
Author Information
------------------
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
+<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
+<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located
+at: https://www.shore.co.il/cgit/.
--
GitLab