From 20cfad5a2603cd59a8e163418f711457324967e1 Mon Sep 17 00:00:00 2001
From: James Mills <1290234+prologic@users.noreply.github.com>
Date: Sun, 20 Aug 2023 21:59:34 +1000
Subject: [PATCH] Add a basic README

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

diff --git a/README.md b/README.md
index d0f0412..ebff4fc 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,30 @@
 # pages-server
 
+> A prototype [Gitea](https://gitea.io) Pages server ala Github Pages (_or Vercal, Netlify, etc_).
+
+Currently supports the following:
+
+- Proxies *.pages.mills.io
+- Option 1: Repo with gitea-pages branch + gitea-pages topic => https://<owner>.pages.mills.io/<repo>/<path>
+- Option 2: Repo of the form <subdomain>.pages.mills.io with gitea-pages branch and gitea-pages topic => https://<subdomain>.pages.mills.io
+
+Demo sites:
+
+- https://actions.pages.mills.io/
+- https://prologic.pages.mills.io/test/
+
+## Quick Start
+
+TBD
+
+## Features
+
+- Proxies `<owner>.<domain>/<repo>` => `owner/repo`
+- Proxies `<subdomain.<domain>` => `owner/subdomain`
+- Automatically sets MIME types on served content.
+- Ues `gitea-pages` as an "opt-in" topic label on repos.
+- Content is served from a `gitea-pages` branch.
+
+## License
+
 TBD