Update Documentation0.2.0

1 files changed, 44 insertions, 3 deletions

diff --git a/README.md b/README.md
index 2e062d0..42abceb 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,24 @@ These dependencies have to be installed:
 
 ## Installation
 
+Please select the right subsection for your system.
+
+### Arch Linux
+
+This software is written for Arch Linux. Visit my [packaging repository ](https://gitea.xengineering.eu/xengineering/pkgbuilds/src/branch/master/xbackup)
+to get the build files. You can then install the software like an AUR package
+following the recommendations in the [Arch wiki](https://wiki.archlinux.org/title/Arch_User_Repository#Installing_and_upgrading_packages).
+
+### Other Linux Distributions
+
+The Makefile of this repository will help you to install the software or create
+a tar archive of a certain commit (which could be helpful for packaging).
+
+Keep in mind, that there is no maintained way to uninstall the software via the
+Makefile! The reason for that is an additional amount of work, the possibility
+of bugs in the uninstall routine and the existence of package managers for Linux
+which guarantee you correct uninstallation.
+
 The Makefile of this repository contains an `install` target. Simply run
 
 ```
@@ -38,6 +56,31 @@ make tarball
 ```
 
 
+## Usage
+
+Please edit the configuration file at `/etc/xbackup/config.json` before you run
+the software. It contains suitable defaults for a full system backup which is
+the main purpose of this script.
+
+Using the default configuration, xbackup will include everything from the root
+folder `/` blacklisting only folders which are not reasonable for a backup,
+because they are virtual filesystems from the Linux kernel (like `/dev`), only
+contain temporary data (like `/tmp`) or are not part of the system itself (like
+`/mnt` or `/media`).
+
+After configuration you can run the backup like this:
+
+```
+sudo xbackup -c path/to/my/config.json backup
+```
+
+In case of the default configuration location `/etc/xbackup/config.json` you can
+skip the `-c` option. In addition you can select `--script` to avoid the
+interactive execution of the script.
+
+For further details run `xbackup --help`.
+
+
 ## Done / Features
 
 (Last finished task first)
@@ -54,12 +97,10 @@ make tarball
 
 (Highest priority first)
 
-- [ ] implement purge command
+- [ ] implement prune command
 - [ ] release v1.0.0
-- [ ] XMPP notification via [xbot](https://gitea.xengineering.eu/xengineering/xbot)
 - [ ] MariaDB fullbackup
 - [ ] backup systemd daemon
 - [ ] backup transfer tool (?)
 - [ ] backup diff tool (backup vs. filesystem)
 - [ ] backup restore tool with qemu (for testing)
-