initial commit

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..db10f6b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Ansible install alacritty terminfo
+
+Role to install the terminfo capabilities of [alacritty](https://alacritty.org/).
+Since alacritty is a rather new and not that widespread terminal it is not
+included in the default terminfo database shipped by distros.
+
+This role installs its capabilities on the host to fix console programs when using
+SSH in an alacritty terminal 
+
+## Requirements
+
+## Example Playbook
+
+```yml
+---
+- hosts: host-pattern
+  roles:
+    - alacritty-terminfo
+```
+
+## 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](https://www.gnu.org/licenses/gpl-3.0.en.html).