Update README.md
This commit is contained in:
parent
9ae8945202
commit
a17b34bce5
1 changed files with 15 additions and 23 deletions
38
README.md
38
README.md
|
@ -1,38 +1,30 @@
|
|||
Role Name
|
||||
=========
|
||||
|
||||
A brief description of the role goes here.
|
||||
# Ansible Role: Develop in Web
|
||||
|
||||
Requirements
|
||||
------------
|
||||
This role installs tools for web development like link checker.
|
||||
|
||||
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.
|
||||
## Requirements
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
This role requires Debian based operating systems.
|
||||
|
||||
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.
|
||||
## Role Variables
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
This role uses no variables.
|
||||
|
||||
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.
|
||||
## Dependencies
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
This role has no dependencies.
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
## Example Playbook
|
||||
|
||||
- hosts: servers
|
||||
- hosts: all
|
||||
roles:
|
||||
- { role: username.rolename, x: 42 }
|
||||
- glenux.develop_in_web
|
||||
|
||||
License
|
||||
-------
|
||||
## License
|
||||
|
||||
BSD
|
||||
GPL-2.0-or-later
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
## Author Information
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
||||
This role was created in 2024 by [Your Name](https://github.com/glenux).
|
||||
|
|
Loading…
Reference in a new issue