aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index ce18e9a..c8140d5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,18 @@
# ansible bash configuration role
+This role installs a simple bashrc for the `remote_user` based on
+[sensible.bash](https://github.com/mrzool/bash-sensible) and a short aliases file.
+
+## Example playbook
+
+```ansible
+---
+- hosts: all
+ roles:
+ - bash
+```
+
## License
-This ansible role is licensed under the term of the GPLv3.
-For further information see the `COPYING` file or [](https://www.gnu.org/licenses/gpl-3.0.en.html).
+This ansible role is licensed under the term of the GPLv3.
+For further information see the `COPYING` file or [https://www.gnu.org/licenses/gpl-3.0.en.html](https://www.gnu.org/licenses/gpl-3.0.en.html).