wip

README.md

@@ -17,7 +17,7 @@
 </h1>
 
 <p align="center">
-Code-Server container optimized for daily use.
+... is a Code-Server container optimized for daily use.
 </p>
 
 <p align="center">
@@ -28,7 +28,7 @@ Code-Server container optimized for daily use.
 
 ## 🤖 Quickstart
 
-### ⚡ Get the image
+### 1. ⚡ Get the image 📦
 
 You can download the image from the gitea embedded container registry: `gitea.ocram85.com/codeserver/arkanum` with these tags:
 
@@ -36,17 +36,18 @@ You can download the image from the gitea embedded container registry: `gitea.oc
 - `next` - Is a test build based on the pull request
 - `1`, `0.1`, `0.1.0` - tag based version. See [packages page](https://gitea.ocram85.com/CodeServer/-/packages/container/arkanum/latest) for available tags.
 
-### Docker Swarm Stack
+### 2.a Run as Docker Swarm Stack
 
-This example shows how to run arkanum as additional swarm stack.
+This example shows how to run arkanum as an additional swarm stack.
 
-This examples requires
+Therefore you need
 
-- an already running docker swarm cluster
-- a running traefik instance handling the http and https routes
-- also configured to watch for services in the `traefik-public` overlay network.
+- an already running docker swarm cluster,
+- a running traefik instance handling the http and https routes,
+- configured to expose services in the a ingress overlay network called `traefik-public`.
 
-> 💡 NOTE: For advanced config with available environment variables see [linuxserver/docker-code-server](https://github.com/linuxserver/docker-code-server) help.
+> ❗ **Warning:** Make sure to secure the access to arkanum with proper **authentication method** and use
+> a trusted + **secure https connection**.
 
 ```yaml
 version: "3.8"
@@ -91,7 +92,8 @@ networks:
     external: true
 ```
 
-### Docker-Compose
+> 💡 NOTE: For advanced config with additional environment variables see [linuxserver/docker-code-server](https://github.com/linuxserver/docker-code-server) help.
+### 2.b Use Docker-Compose
 
 This is a basic example for a `docker-compose` file from the [linuxserver/docker-code-server](https://github.com/linuxserver/docker-code-server) project.
 
@@ -101,7 +103,7 @@ See their [docs](https://github.com/linuxserver/docker-code-server#parameters) a
 ---
 version: "3.8"
 services:
-  code-server:
+  arkanum:
     image: gitea.ocram85.com/codeserver/arkanum:0.0.1
     container_name: code-server
     environment:
@@ -121,11 +123,11 @@ services:
     restart: unless-stopped
 ```
 
-### First Steps
+### 3. 🦶 First Steps
 
 After summon Arkanum your first steps should be to set your username and email in the git config:
 
-```
+```bash
 git config --global user.name "username"
 git config --global user.email "email address"
 ```
@@ -185,7 +187,7 @@ This helps reducing the image size.
 
 Added FiraCode as default font in editor and integrated terminal. The font files are embedded and can be used without local installation.
 
-### VSCode default settings
+### 🦸 VSCode default settings
 
 If your start the container or log in the first time, a default config file is deployed.
 
@@ -209,9 +211,9 @@ Additionally we install these extensions on container startup:
 - [vscode-icons](https://open-vsx.org/extension/vscode-icons-team/vscode-icons) icon set
 - [Gitlens](https://open-vsx.org/extension/eamodio/gitlens)
 
-## 💣 Know Issues
+## 💣 Known Issues
 
-### Default extensions installation timing error
+### 🐛 Default extensions installation timing error
 
 If the automatic installation of the default extension fails, you can always retry he installation with the
 following command:
@@ -261,7 +263,7 @@ Akranum is based on the following projects and wouldn't be possible without:
 
 ```
 Arkanum - Code-Server container optimized for daily use.
-Copyright (C) 2022  "OCram85 <me@ocram85.com>"
+Copyright (C) 2022 "OCram85 <me@ocram85.com>"
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by