From a72a07c2e58c55291630be2d09b07db12c854a9d Mon Sep 17 00:00:00 2001
From: Radu Ursache <3800336+rursache@users.noreply.github.com>
Date: Mon, 12 Dec 2022 18:11:48 +0200
Subject: [PATCH] Update README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index 61190b4..d6d0f2f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
 # VSCode Server Swift MOD
 
+![Swift](https://i.imgur.com/1fpf5HJ.png)
+
+This MOD installs Swift binaries to be used in VSCode at startup. [linuxserver](https://www.linuxserver.io/)'s [code-server image](https://hub.docker.com/r/linuxserver/code-server) is used as core
+
+> **Note** 
+>
+> You also need the [code-server-extension-arguments](https://github.com/linuxserver/docker-mods/tree/code-server-extension-arguments) MOD to supply the official VS marketplace where [sswg.swift-lang](https://marketplace.visualstudio.com/items?itemName=sswg.swift-lang) exists. 
+> 
+> This MOD will try to install it if you provide the correct envs.
+
+### Full example
+```sh
+docker run -d \
+  --name=vscodeserver \
+  --restart unless-stopped \
+  -p 8443:8443 \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e TZ=Europe/Bucharest \
+  -e DOCKER_MODS="linuxserver/mods:code-server-extension-arguments|rursache/vscode-swift-linuxserver-mod" \
+  -e VSCODE_EXTENSION_IDS="sswg.swift-lang"\
+  -e EXTENSIONS_GALLERY='{"serviceUrl": "https://marketplace.visualstudio.com/_apis/public/gallery", "cacheUrl": "https://vscode.blob.core.windows.net/gallery/index", "itemUrl": "https://marketplace.visualstudio.com/items"}' \
+  -v /home/USER/.vscodeserver/config:/config \
+  -v /home/USER/.vscodeserver/projects:/projects \
+  -v /opt/swift:/swift \
+  lscr.io/linuxserver/code-server:latest
+```