Update the README
This commit is contained in:
parent
befa0a8e3d
commit
9295dbd64c
1 changed files with 20 additions and 6 deletions
26
README.md
26
README.md
|
|
@ -13,13 +13,27 @@ This role requires Ansible 1.2 or higher and platform requirements are listed in
|
||||||
Role Variables
|
Role Variables
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
You can override the following variables:
|
The role uses the following variables:
|
||||||
|
|
||||||
# Url to download the composer executable from
|
- **composer_download_url**: Defines the download url of the composer.phar.
|
||||||
composer_download_url: https://getcomposer.org/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
|
Global Variables
|
||||||
composer_download_force: no
|
--------------
|
||||||
|
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
|
Dependencies
|
||||||
------------
|
------------
|
||||||
|
|
@ -34,4 +48,4 @@ BSD
|
||||||
Author Information
|
Author Information
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
Sergey Fayngold
|
- Sergey Fayngold <sergey@faynhost.com>
|
||||||
Loading…
Add table
Add a link
Reference in a new issue