From 921572d053eccf88835d8065b6cd1c56e73ca14b Mon Sep 17 00:00:00 2001
From: mediocregopher <>
Date: Sun, 29 Mar 2020 16:38:08 -0600
Subject: [PATCH] Documentation fixes for dehub-remote and git-http-server

---
type: change
message: Documentation fixes for dehub-remote and git-http-server
change_hash: AHgOc66WotsrgX4qfuIWuI1kcI1prxoUvd4L5VKR3onI
credentials:
- type: pgp_signature
  pub_key_id: 95C46FA6A41148AC
  body: iQIzBAABAgAdFiEEJ6tQKp6olvZKJ0lwlcRvpqQRSKwFAl6BI0UACgkQlcRvpqQRSKxcww//fSTl5noQ7ozmlchJjE+Us0RLDK4OCjKriEvF1eaulJQNYEu+d4YJCoCJ0GMQoRvng3zgbal+juHTCZVERCI3Q8wkAk3j6UxYPcuUfzH4DAZmwH7Y9EpwofXeB3ZnVypObQpy0EzlaqIfbk/UAvMuZc+u4c+0wFUR8gBk8rydnpAV4okD6t56U8uUwQtjvF1siCakcCSEHKRx2juDdjwMIA95BebsTZ+SiBgwh2p7sWbRn2+WCqCU0F62esG+1OHeSSkQFF2nI4Wz7t3iZfmMRExsxyfnvyTRlvDuvHNb/3d9hh+7oQmeZ1YcNOwbeWOY7MmO1cTqMbg+oaf3KOj04kyQg8oDPJZfFadW7a9ITzj+O8zVGJZXTDh6A6FVTfTnwx1t04JrkAncnd7/lQTYbRk8RcIrFtzXUkbd9l7eucooINk+sRek4jvGexQZhMjATaC6Qe1lHgYH0raWeAaoFfTXIqPlGPvsCSU8jBivZqvDrXF8u+2sneLKXw2EFmXp5OvzzIP40htZHNTX58Mx7D+09sIxJU3rN1R/bvxidyMW/+EKiP/3JgEW7kXPOc1tRdEMb1rJ6Iufy6mCkNgZXboI1uAr0Q9JB3GB08ocf2JA8mhSpuVWUssF0u3i5R47dmbwxsc3v4V/i8xPoO05b/n5I3TmLqR0ewiXUvCR4J8=
  account: mediocregopher
---
 README.md                     | 8 ++++++--
 cmd/dehub-remote/README.md    | 7 ++++---
 cmd/git-http-server/README.md | 9 +++++++--
 3 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 8db4a11..40fbb6b 100644
--- a/README.md
+++ b/README.md
@@ -92,6 +92,10 @@ in its coverage.
 [ROADMAP](/ROADMAP.html) documents upcoming features and other work required on
 the project. If you're looking to contribute, this is a great place to start.
 
-[dehub-remote](/cmd/dehub-remote) TODO
+[dehub-remote](/cmd/dehub-remote/) is a simple docker image which can be used to
+host a remote dehub project over http(s). The endpoint will automatically verify
+all pushed commits.
 
-[git-http-server](/cmd/git-http-server) TODO
+[git-http-server](/cmd/git-http-server/) is a small server which makes a git
+repo's file tree available via http. It will automatically render markdown files
+to html as well. git-http-server is used to render dehub's website.
diff --git a/cmd/dehub-remote/README.md b/cmd/dehub-remote/README.md
index 43c4bab..ad92cd0 100644
--- a/cmd/dehub-remote/README.md
+++ b/cmd/dehub-remote/README.md
@@ -18,7 +18,6 @@ Running the following:
 docker run \
     --name dehub \
     -v /opt/dehub/repos:/repos \
-    -v /opt/dehub/www:/var/www \
     -p 8080:80 \
     mediocregopher/dehub-remote repo-a.git repo-b.git
 ```
@@ -28,8 +27,10 @@ repo folders. It will then initialize repo directories at
 `/opt/dehub/repos/repo-a.git` and `/opt/dehub/repos/repo-b.git`, if they arent
 already there.
 
-If a volume for `/var/www` is given then that will be used as the root for all
-non-git http requests.
+## Extras
+
+For convenience the docker image also includes the
+[git-http-server](../git-http-server/) binary.
 
 ## Contributors
 
diff --git a/cmd/git-http-server/README.md b/cmd/git-http-server/README.md
index 5ff6144..579c82a 100644
--- a/cmd/git-http-server/README.md
+++ b/cmd/git-http-server/README.md
@@ -4,14 +4,19 @@ A simple http server which uses a git repo (bare or otherwise) as the underlying
 filesystem.
 
 * Automatically renders markdown files as html.
-* Will use README.md as the index, if available.
+* Will use `README.md` as the index, if available.
 * Can be set to use a specific branch.
 
 All configuration is done on the command-line.
 
 # Installation
 
-TODO
+Installation of git-http-server is done in the same manner as the `dehub`
+command itself:
+
+```
+go get dehub.dev/src/dehub.git/cmd/git-http-server
+```
 
 # Markdown