Add README

cakephp · Jan 21, 2025 · cfae277 · cfae277
1 parent 862caab
commit cfae277
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+This repository is published as a dokku application that handles `api.cakephp.org`.
+
+The primary function of this is to create an nginx instance that handles proxying requests to the various versions of the API docs that are published.
+Each of these servers has separate `location` directives that unify the URL space.
+
+The `web.py` script is used to trick dokku into having a process to monitor.
+
+# Deployment
+
+This application is deployed on each push to `master`. Deployment is handled by GitHub Actions.