diff --git a/README.md b/README.md index 8b131af..b46d2c7 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,14 @@ # xoxys.users - -[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.users/status.svg)](https://drone.rknet.org/ansible/xoxys.users) + +[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.users?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.users) Manage users and default bash environment -## Table of content +### License -* [Default Variables](#default-variables) - * [users_bash_bashrc_overrides](#users_bash_bashrc_overrides) - * [users_default_groups](#users_default_groups) - * [users_default_umask](#users_default_umask) - * [users_default_users](#users_default_users) - * [users_global_bash_aliases](#users_global_bash_aliases) -* [Dependencies](#dependencies) -* [License](#license) -* [Author](#author) +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ---- +### Maintainers and Contributors -## Default Variables - -### users_bash_bashrc_overrides - -#### Default value - -```YAML -users_bash_bashrc_overrides: [] -``` - -#### Example usage - -```YAML -users_bash_bashrc_overrides: - - /etc/skel/.bashrc - - /root/.bashrc -``` - -### users_default_groups - -#### Default value - -```YAML -users_default_groups: [] -``` - -### users_default_umask - -#### Default value - -```YAML -users_default_umask: '022' -``` - -### users_default_users - -#### Default value - -```YAML -users_default_users: [] -``` - -#### Example usage - -```YAML -users_default_users: - - name: admin - groups: - - wheel - password: "secure" - key: "ssh-ed25519 AAAA..." - shell: /bin/bash -``` - -### users_global_bash_aliases - -#### Default value - -```YAML -users_global_bash_aliases: - - alias: ll - command: ls -lh - - alias: la - command: ls -lha -``` - -## Dependencies - -None. - -## License - -MIT - -## Author - -[xoxys](https://gitea.rknet.org/xoxys) +[Robert Kaussow](https://gitea.rknet.org/xoxys)