From 9295dbd64ca84efbc1258dd745ca04d9561e5808 Mon Sep 17 00:00:00 2001 From: Sergey Fayngold Date: Wed, 14 Jan 2015 13:21:50 +0100 Subject: [PATCH] Update the README --- README.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a45e703..7f70e77 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,27 @@ This role requires Ansible 1.2 or higher and platform requirements are listed in Role Variables -------------- -You can override the following variables: +The role uses the following variables: - # Url to download the composer executable from - composer_download_url: https://getcomposer.org/composer.phar + - **composer_download_url**: Defines the download url of the composer.phar. + Defaults to ```https://getcomposer.org/composer.phar```. + - **composer_download_force**: Forces the download on every run. + Defaults to ```no```. - # Force the download on every run - composer_download_force: no +Global Variables +-------------- +This variables are without a namespace to be used across the entire playbook + - **apt_cache_valid_time**: Used for ```cache_valid_time``` in the apt module. + Defaults to ```86400``` + +Example usage +------- + + --- + # file: task.yml + - hosts: all + roles: + - nbz4live.composer Dependencies ------------ @@ -34,4 +48,4 @@ BSD Author Information ------------------ -Sergey Fayngold \ No newline at end of file +- Sergey Fayngold \ No newline at end of file