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://.pages.mills.io// +- Option 2: Repo of the form .pages.mills.io with gitea-pages branch and gitea-pages topic => https://.pages.mills.io + +Demo sites: + +- https://actions.pages.mills.io/ +- https://prologic.pages.mills.io/test/ + +## Quick Start + +TBD + +## Features + +- Proxies `./` => `owner/repo` +- Proxies `` => `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