Documentation & minor tag

.gitattributes

@@ -0,0 +1,2 @@
+*.yml linguist-detectable=true
+*.yaml linguist-detectable=true

README.md

@@ -1 +1,38 @@
 # Pihole Ansible role
+
+[![Build Status](https://travis-ci.com/blalop/pihole_role.svg?branch=main)](https://travis-ci.com/blalop/pihole_role)
+
+This role installs pihole via installation script. Tested on Debian && Raspbian.
+
+## Requirements
+
+No special requirements.
+
+
+## Role vars
+
+| Variable                   | Default     | Additional comments                                                                                  |
+| :---                       | :---        | :---                                                                                                 |
+| `pihole_required_packages` | [procps]    |                                                                                                      |
+| `pihole_password`          | pihole      | Pihole web interface password                                                                        |
+| `pihole_force_reinstall`   | false       | Forces reinstallation                                                                                |
+| `pihole_lighttpd_port`     | 80          | Web interface port                                                                                   |
+| `pihole_interface`         | eth0        | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
+| `pihole_ipv4_address`      | 0.0.0.0     | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
+| `pihole_ipv6_address`      | 0:0:0:0:0:0 | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
+| `pihole_dns_1`             | 8.8.8.8     | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
+| `pihole_dns_2`             | 4.4.4.4     | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
+| `pihole_query_logging`     | true        | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
+| `pihole_web_server`        | true        | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
+| `pihole_web_interface`     | true        | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
+| `pihole_lighttpd_enabled`  | true        | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
+
+
+## Testing
+
+Test the role via molecule:
+
+```
+pipenv sync
+pipenv run molecule test
+```

tasks/main.yml

@@ -5,6 +5,8 @@
   register: pihole_version_check
   ignore_errors: true
   changed_when: false
+  tags:
+    - pihole_install
 
 - name: Pi-hole | Install
   include: install.yml