Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update the description of the role.
  • Loading branch information
robertdebock committed Jan 5, 2019
1 parent 20d725f commit 3e58a78
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
18 changes: 12 additions & 6 deletions README.md
Expand Up @@ -3,13 +3,13 @@ tftpd

[![Build Status](https://travis-ci.org/robertdebock/ansible-role-tftpd.svg?branch=master)](https://travis-ci.org/robertdebock/ansible-role-tftpd)

The purpose of this role is to install and configure tftpd on your system.
Install and configure tftpd on your system.

Example Playbook
----------------

This example is taken from `molecule/default/playbook.yml`:
```
```yaml
---
- name: Converge
hosts: all
Expand All @@ -27,7 +27,7 @@ Role Variables
--------------

These variables are set in `defaults/main.yml`:
```
```yaml
---
# defaults file for tftpd

Expand All @@ -47,10 +47,12 @@ Requirements

The following roles can be installed to ensure all requirements are met, using `ansible-galaxy install -r requirements.yml`:

```yaml
---
- robertdebock.bootstrap
- robertdebock.xinetd

```

Context
-------
Expand Down Expand Up @@ -104,9 +106,13 @@ To test on Amazon EC2, configure [~/.aws/credentials](https://docs.aws.amazon.co
There are many specific scenarios available, please have a look in the `molecule/` directory.

Run the [ansible-galaxy](https://github.com/ansible/galaxy-lint-rules) and [my](https://github.com/robertdebock/ansible-lint-rules) lint rules if you want your change to be merges:
```
ansible-lint -r /path/to/galaxy-lint-rules/rules .
ansible-lint -r /path/to/ansible-lint-rules/rules .

```shell
git clone https://github.com/ansible/ansible-lint.git /tmp/ansible-lint
ansible-lint -r /tmp/ansible-lint/lib/ansiblelint/rules .

git clone https://github.com/robertdebock/ansible-lint /tmp/my-ansible-lint
ansible-lint -r /tmp/my-ansible-lint/rules .
```

License
Expand Down
2 changes: 1 addition & 1 deletion meta/main.yml
Expand Up @@ -2,7 +2,7 @@
galaxy_info:
author: Robert de Bock
role_name: tftpd
description: The purpose of this role is to install and configure tftpd on your system.
description: Install and configure tftpd on your system.
license: Apache-2.0
company: none
min_ansible_version: 2.6
Expand Down

0 comments on commit 3e58a78

Please sign in to comment.