Merge branch 'master' of https://github.com/CupCakeArmy/ixesha

README.md

@@ -4,25 +4,24 @@
 
 🐍 Written in python.
 
-###### Example 💥
+###### Getting started example 💥
 
 ```bash
-python3 ixesha.py --backup ~/ --output /mnt/backup/home
+python3 ixesha --install
+ixesha --backup ~/ --output /mnt/backup/home
 ```
 
-## Setup 
+## Setup
 
 ### Requirements
 
 - `Python3`
 - `rsync` (min. v3.1.1)
 
-### Installation 🚂
-
 ###### macOS
 
-1. Install [brew](https://brew.sh/): `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
+1. Get [Brew](https://brew.sh/): `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
-2. Install `python3` and `rsync`: `brew install python3 rsync`
+2. Run: `brew install python3 rsync`
 
 ###### debian / ubuntu
 
@@ -32,29 +31,51 @@ python3 ixesha.py --backup ~/ --output /mnt/backup/home
 
 Well... I don't know...
 
+## Installation 🚂
+
+__Optionally__ you can install/uninstall the script globally. Usefull but __not__ required.
+
+It will be saved to: `/usr/local/bin/`
+
+###### Install
+
+```bash
+python3 ixesha --install
+```
+
+###### Uninstall
+
+```bash
+python3 ixesha --uninstall
+```
+
 ## Usage 👾
 
 ### Run 🚀
 
-```bash
+Run with: `python3 ixesha` or `./ixesha`
-python3 ixesha.py --backup <my-folder> --output <where-to-save-it>
-```
 
-or with only bash: ```./ixesha -b <my-folder> -o <where-to-save-it>```
+If [installed](#install) simply: `ixesha`
+
+```bash
+ixesha --backup <my-folder> --output <where-to-save-it>
+```
 
 ###### Example
 
 Backup my home folder for example to some mounted drive
 
 ```bash
-python3 ixesha.py --backup ~/ --output /mnt/backupdrive/home
+ixesha --backup ~/ --output /mnt/backupdrive/home
 ```
 
 ### Arguments
 
 - `-h` `--help` Show help dialog
-- `-b` `--backup` The folder to be backed up
+- `-b` `--from` `--backup` The folder to be backed up
-- `-o` `--output` Location where the snapshots will be saved
+- `-o` `--to` `--output` Location where the snapshots will be saved
+- `-i` `--install` Install the script globally
+- `-u` `--uninstall` Uninstall the script globally
 
 ### Cron 🕰
 
@@ -64,4 +85,4 @@ If you want to run it every x... you can create a cronjob
 Run the script every 5 Min (More details on [cronjobs](http://www.cyberciti.biz/faq/how-do-i-add-jobs-to-cron-under-linux-or-unix-oses/))
 
 1. Edit your cron file with: `crontab -e`
-2. Add: `*/5 * * * * python3 /path/to/ixesha.py -b /some/folder -o /some/backup/location`
+2. Add: `*/5 * * * * ixesha -b /some/folder -o /some/backup/location`