commit 35cb36cab66d939e73fcc048d54ce6021a87db58
Author: pvincent <pvincent@artcode.re>
Date:   Thu Feb 22 09:39:34 2024 +0400

    first commit

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e99d64a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+MIAOU-BASH
+===========
+
+MIAOU-BASH is a collection of settings and helpers for leveraging BASH.
+Developer-friendly, it may be used as solo package with or without the miaou project.
+
+## Featuring
+
+* [x] some aliases (l, ll, ltr, ...)
+* [x] a smart prompt
+  * [x] git, lxd, failure aware
+* [x] simple vim and micro settings 
+
+It's Free Software (GPLv3), help yourself.
+Any feedback would be appreciated. [contact@artcode.re](mailto:contact@artcode.re)
+
+install
+-------------
+
+`curl https://git.artcode.re/miaou/miaou-bash/raw/branch/master/install.sh | sudo bash -s -- --host`
+
+uninstall
+---------
+
+* `cd /opt/miaou-bash && sudo ./uninstall.sh`
+
+development mode (credentials required)
+---------------------------------------
+
+* git clone git@artcode.re:miaou/miaou-bash.git -C ~/DEV/BASH
+* sudo ln -s $HOME/DEV/BASH/miaou-bash /opt/miaou-bash
+* sudo /opt/miaou-bash/install.sh --host
+
+useful library 
+--------------
+
+* source /opt/miaou-bash/lib/functions.sh
+
+bindkeys
+--------
+
+### by default
+
+* CTRL + C => stop program
+* CTRL + V => display bindkey
+* CTRL + Z => interrupt for background job (fg, bg)
+
+* SHIFT + CTRL + C => copy
+* SHIFT + CTRL + V => paste
+
+### customized
+
+* CTRL LEFT, RIGHT => move between words
+* CTRL DELETE, BACKSPACE => delete word
+* ALT DELETE, BACKSPACE => delete line from cursor
+* CTRL + SHIFT + / => undo