From 9a113bf01374956d7b894a9bd5e497911d6bcbc9 Mon Sep 17 00:00:00 2001
From: glenux <glenux@glenux.net>
Date: Fri, 12 Jul 2024 13:01:24 +0000
Subject: [PATCH] Update README.md

---
 README.md | 58 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 34 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 225dd44..3e9566f 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,48 @@
-Role Name
-=========
+# Ansible Role: VLC
 
-A brief description of the role goes here.
+[![CI](https://travis-ci.org/glenux/ansible-role-vlc.svg?branch=master)](https://travis-ci.org/glenux/ansible-role-vlc)
 
-Requirements
-------------
+This role installs VLC and configures it to work with Freebox TV.
 
-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 Ansible 2.9 or higher.
 
-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
-------------
+Available variables are listed below, along with default values (see `defaults/main.yml`):
 
-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.
+```yaml
+glenux_vlc_users: []
+```
 
-Example Playbook
-----------------
+A list of users for whom to configure VLC.
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+```yaml
+glenux_vlc_live555_rtp_client_port: "-666"
+glenux_vlc_rtp_rtcp_port: "-666"
+```
 
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
+Network ports configuration for Freebox TV. Usually, you don't need to modify these values.
 
-License
--------
+## Dependencies
 
-BSD
+None.
 
-Author Information
-------------------
+## Example Playbook
+
+```yaml
+- hosts: all
+  become: true
+  roles:
+    - glenux.vlc
+```
+
+## License
+
+GPL-2.0-or-later
+
+## Author Information
+
+This role was created by glenux.
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).