Skip to content

Commit 6b5c594

Browse files
committed
slight formatting change on the README file.
1 parent 814de67 commit 6b5c594

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,32 @@ A brief description of the role goes here.
99

1010
## Requirements
1111

12-
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.
12+
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here.
13+
For instance, if the role uses the EC2 module,
14+
it may be a good idea to mention in this section that the boto package is required.
1315

1416
- ansible >= 1.7.2
1517

1618
## Role Variables
1719

18-
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.
20+
A description of the settable variables for this role should go here,
21+
including any variables that are in defaults/main.yml, vars/main.yml and
22+
any variables that can/should be set via parameters to the role.
23+
24+
Any variables that are read from other roles and/or
25+
the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
1926

2027
## Dependencies
2128

22-
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.
29+
A list of other roles hosted on Galaxy should go here,
30+
plus any details in regards to parameters that may need to be set for other roles
31+
or variables that are used from other roles.
2332

2433
## Example Playbook
2534

26-
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
35+
Including an example of how to use your role
36+
(for instance, with variables passed in as parameters)
37+
is always nice for users too:
2738

2839
- hosts: servers
2940
roles:
@@ -40,4 +51,5 @@ BSD
4051

4152
## Author Information
4253

43-
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
54+
An optional section for the role authors to include contact information or
55+
a website (HTML is not allowed).

0 commit comments

Comments
 (0)