diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..39067b1 --- /dev/null +++ b/readme.md @@ -0,0 +1,10 @@ +## Intro +Borg alias and functions is designed to facilitate the daily use of BorgBackup. You will have to be in the repository folder to make these aliases and functions work. +To display a summary of available functions, type `bobaman` or `bobahelp` in your terminal. + +## Installation +To include this file in your bashrc, place the file in a script folder of your choice (I choose `~/bin/`) and add this line to your bashrc : + +``` +. $HOME/bin/borgaliasandfunctions.txt +``` \ No newline at end of file