From e466b593044723f831eb0c1eb61ddc3ec5c5f594 Mon Sep 17 00:00:00 2001 From: Nicco Date: Sun, 21 Jan 2018 13:52:04 +0100 Subject: [PATCH] V1.0 --- README.md | 51 ++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 36 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 60cd18e..2f60383 100644 --- a/README.md +++ b/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)"` -2. Install `python3` and `rsync`: `brew install python3 rsync` +1. Get [Brew](https://brew.sh/): `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"` +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 -python3 ixesha.py --backup --output -``` +Run with: `python3 ixesha` or `./ixesha` -or with only bash: ```./ixesha -b -o ``` +If [installed](#install) simply: `ixesha` + +```bash +ixesha --backup --output +``` ###### 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 -- `-o` `--output` Location where the snapshots will be saved +- `-b` `--from` `--backup` The folder to be backed up +- `-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`