From e1375303334ca0d5d5fcbc703ec803286b7a65ca Mon Sep 17 00:00:00 2001 From: glenux Date: Fri, 12 Jul 2024 13:04:42 +0000 Subject: [PATCH] Add README.md --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6890d30 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +```markdown +# Ansible Role: Tmux + +[![CI](https://github.com/glenux/ansible-role-tmux/workflows/CI/badge.svg?event=push)](https://github.com/glenux/ansible-role-tmux/actions?query=workflow%3ACI) + +This role installs Tmux on Debian/Ubuntu servers and provides a basic configuration for all users defined in `tmux_users` variable. + +## Requirements + +None. + +## Role Variables + +Available variables are listed below, along with default values (see `defaults/main.yml`): + + tmux_users: [] + +A list of users for whom a `.tmux.conf` will be created in their home directory. + +## Dependencies + +None. + +## Example Playbook + + - hosts: servers + vars_files: + - vars/main.yml + roles: + - { role: glenux.tmux } + +*Inside `vars/main.yml`*: + + tmux_users: + - johndoe + - deployacct + +## License + +MIT / BSD + +## Author Information + +This role was created in 2024 by [Your Name](https://yourwebsite.com). +``` \ No newline at end of file