From bbad5f21372999fdfb684b2341f05b8c4db0c51d Mon Sep 17 00:00:00 2001 From: Farhad Shahbazi Date: Tue, 8 Mar 2016 11:21:35 +0100 Subject: [PATCH] add README --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..950a5d4 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +Common +====== + +Some common tasks for Debian hosts + +Requirements +------------ + +Ansible 1.9 or higher. Platform requirements are listed in the metadata file. + +Dependencies +------------ + +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: SphericalElephant.common + common_basic_packages: ['vim', 'zsh'], + common_mailer: False, + common_resolvconf_nameservers: ['1.2.3.4', '2.3.4.5'] + +License +------- + +This project is released under the MIT license (see the LICENSE file).