From 1fb695a0ab405ad5b41e400db7fa379d4e229e42 Mon Sep 17 00:00:00 2001
From: Tobias B <germansuperioz@yahoo.de>
Date: Tue, 16 Nov 2021 22:16:21 +0100
Subject: [PATCH] Add even more documentation

---
 README.md          | 43 +++++++++++++++++++++++++++----------------
 docker-compose.yml | 34 +++++++++++++++++-----------------
 2 files changed, 44 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index a80387b..61453c1 100644
--- a/README.md
+++ b/README.md
@@ -13,21 +13,25 @@ It is the successor/rework of my previous project [lightf](https://github.com/Su
 
 There are as always multiple ways to install the server. The recommended way is to use Docker Compose or deploy it to Kubernetes, but we start with the manual way.
 
-## Manual
+## Manually
 
-- download the specific binary from the latest release
-- rename it however you want
-- create an auth.yml
-- do the rest of the configuration like described below (creating environment variables and such)
-- start the server and open port 8765 to the outside world from your server/machine
+This is only for those people, that are still living in the 90s or are not comfortable with a Docker installation.
+
+1. First download the specific binary from the [releases](https://github.com/Superioz/aqua/releases) and put it somewhere (e.g. with `wget` on Linux). Also, add execution permission
+   with `chmod +x aq-linux-amd64`.
+2. Do the configuration you want (e.g. setting environment variables and creating an `auth.yml`). See [Configuration](#configuration)
+3. Execute the downloaded binary and don't forget to open port `8765` on your machine/server.
+
+For further instructions like creating a service that can easily be started with `service aqua start`, please refer to other pages (there are a bunch that explain this) - I won't.
 
 ## Docker Compose
 
-- install docker and docker-compose on your machine
-- git clone the repository
-- edit the auth.yml (it has to be in the same directory as the docker-compose)
-- edit the .env.dist -> rename it to .env and edit it however you want (see Configuration)
-- `docker-compose up`
+Before following the steps, make sure you have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on the machine.
+
+1. Clone the repository to a directory of your liking with `git clone git@github.com:Superioz/aqua.git`
+2. Edit the `auth.yml` with your custom auth tokens and settings.
+3. Rename the `.env.dist` to `.env` and edit it as well.
+4. `docker-compose up` and you should see it up and running.
 
 ## Kubernetes
 
@@ -85,10 +89,17 @@ text/plain
 
 # CLI Tool
 
-- download binary for the cli
-- possibly rename and put it somewhere in $PATH
-- use it to upload a file
+Installing the CLI tool is fairly simple. Just download the respective binary from [releases](https://github.com/Superioz/aqua/releases), rename it and put it somewhere in your `$PATH`.
+Don't forget to add execution permissions `chmod +x aq`.
 
-```console
-user@host:~$ aq upload --host https://my-domain.com:8765 --token my_token local_file.png
+Now to upload a local file, you just have to execute the following command:
+
+```sh
+aq upload --host https://my-domain.com:8765 --token my_token local_file.png
+```
+
+To upload multiple files at the same time, just do it like this:
+
+```sh
+aq upload --host https://my-domain.com:8765 --token my_token local_file1.png local_file2.txt [...]
 ```
diff --git a/docker-compose.yml b/docker-compose.yml
index 7bb7894..615ea28 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,17 +1,17 @@
-version: "3.1"
-
-services:
-  aqua:
-    image: superioz/aqua:0.4.0
-    build: .
-    env_file:
-    - .env
-    ports:
-    - 8765:8765
-    restart: always
-    volumes:
-    - ${PWD}/auth.yml:/etc/aqua/auth.yml
-    - aqua:/var/lib/aqua
-
-volumes:
-  aqua:
\ No newline at end of file
+version: "3.1"
+
+services:
+  aqua:
+    image: ghcr.io/superioz/aqua:latest
+    build: .
+    env_file:
+    - .env
+    ports:
+    - 8765:8765
+    restart: always
+    volumes:
+    - ${PWD}/auth.yml:/etc/aqua/auth.yml
+    - aqua:/var/lib/aqua
+
+volumes:
+  aqua: