Edit readme

2019-04-11 00:30:53 +02:00 · 2019-04-11 00:30:53 +02:00 · 3536e0adba
parent a2f21cae57
commit 3536e0adba
1 changed files with 25 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,25 @@
-# rsync-linux-home
+# rsync-linux-home
+
+A simple script to make backups of your linux home.
+
+## Usage
+1. Configure UUID of destination partition into `rsync-linux-home.py`:
+    ```
+    DRIVE_UUID="<set here your UUID Partition>"
+    ```
+
+2. Configure which folders to include and which to exclude, changing arrays `INCLUDES`/`EXCLUDES` into `rsync-linux-home.py`:
+    ```
+    INCLUDES = [...]
+    EXCLOUDES = [...]
+    ```
+
+3. Make the script executable
+    ```
+    chmod +x rsync-linux-home.py
+    ```
+
+4. Launch the script to perform the backup
+    ```
+    ./rsync-linux-home.py
+    ```