Break out Docker info in README

Christian Rocha created 3 years ago

Change summary

DOCKER.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
README.md | 33 ++++-----------------------------
2 files changed, 50 insertions(+), 29 deletions(-)

Detailed changes

DOCKER.md

@@ -0,0 +1,46 @@
+# Running Soft-Serve with Docker
+
+The official Soft Serve Docker images are available at [charmcli/soft-serve][docker].
+
+```sh
+docker pull charmcli/soft-serve:latest
+```
+
+Here’s how you might run `soft-serve` as a container.  Keep in mind that
+repositories are stored in the `/soft-serve` directory, so you’ll likely want
+to mount that directory as a volume in order keep your repositories backed up.
+
+```sh
+docker run -d \
+  --name=soft-seve \
+  --volume /path/to/data:/soft-serve \
+  --publish 23231:23231 \
+  --restart unless-stopped \
+  charmcli/soft-serve:latest
+```
+
+Or by using docker-compose:
+
+```yaml
+---
+version: "3.1"
+services:
+  soft-serve:
+    image: charmcli/soft-serve:latest
+    container_name: soft-serve
+    volumes:
+      - /path/to/data:/soft-serve
+    ports:
+      - 23231:23231
+    restart: unless-stopped
+```
+
+[docker]: https://hub.docker.com/r/charmcli/soft-serve
+
+***
+
+Part of [Charm](https://charm.sh).
+
+<a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge-unrounded.jpg" width="400"></a>
+
+Charm热爱开源 • Charm loves open source

README.md

@@ -10,7 +10,7 @@ Soft Serve
     <a href="https://github.com/charmbracelet/soft-serve/actions"><img src="https://github.com/charmbracelet/soft-serve/workflows/build/badge.svg" alt="Build Status"></a>
 </p>
 
-A tasty Git server that runs its own SSH service. 🍦
+A tasty, self-hosted Git server for the command line. 🍦
 
 <img src="https://stuff.charm.sh/soft-serve/soft-serve-cli-demo.gif" width="700" alt="Soft Serve screencast">
 
@@ -41,34 +41,7 @@ go install
 
 Make sure `git` is installed, then run `soft`. That’s it.
 
-## Docker
-
-Here are some example snippets to help you run `soft-serve` as a container.
-
-```sh
-docker run -d \
-  --name=soft-seve \
-  -v /path/to/data:/soft-serve \
-  -p 23231:23231 \
-  --restart unless-stopped \
-  charmcli/soft-serve:latest
-```
-
-or by using docker-compose:
-
-```yaml
----
-version: "3.1"
-services:
-  soft-serve:
-    image: charmcli/soft-serve:latest
-    container_name: soft-serve
-    volumes:
-      - /path/to/data:/soft-serve
-    ports:
-      - 23231:23231
-    restart: unless-stopped
-```
+A [Docker image](https://github.com/charmbracelet/soft-serve/blob/main/DOCKER.md) is also available.
 
 ## Configuration
 
@@ -179,6 +152,8 @@ environment-level settings:
 
 ***
 
+Part of [Charm](https://charm.sh).
+
 <a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge-unrounded.jpg" width="400"></a>
 
 Charm热爱开源 • Charm loves open source