aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fischer@muhq.space>2022-03-25 14:09:31 +0100
committerFlorian Fischer <florian.fischer@muhq.space>2022-03-25 14:14:35 +0100
commit12587c7156b8ff4375e28b3298d130de97e7e550 (patch)
tree090aa500620f88bd600e2aad61b9fb7e73e1eb25
parenta4f85b46c231656fcd47e51cbeef8ae333aea5d0 (diff)
downloadbash-12587c7156b8ff4375e28b3298d130de97e7e550.tar.gz
bash-12587c7156b8ff4375e28b3298d130de97e7e550.zip
improve README
* Write about what this role does. * Add sample playbook. * Improve License section.
l---------LICENSE1
-rw-r--r--README.md16
2 files changed, 15 insertions, 2 deletions
diff --git a/LICENSE b/LICENSE
new file mode 120000
index 0000000..d24842f
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1 @@
+COPYING \ No newline at end of file
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).