docs: readme

diff --git a/docs/Caddyfile b/docs/Caddyfile
new file mode 100644 (file)
index 0000000..58d1654
--- /dev/null
+++ b/docs/Caddyfile
@@ -0,0 +1,7 @@
+http://{$CADDY_ADDRESS} {
+       route {
+               uri strip_prefix /ext-ion
+               try_files {path}.html {path}/ {path}/index.html {path} =404
+               file_server
+       }
+}

diff --git a/docs/README.md b/docs/README.md
new file mode 100644 (file)
index 0000000..03a34e2
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,42 @@
+# Read the docs
+Run caddy to read the docs as the would appear on https://awesomized.github.io/ext-ion.
+
+```sh
+caddy run
+```
+Use `$CADDY_ADDRESS` envvar to customize the HTTP endpoint, e.g:
+```
+CADDY_ADDRESS=localhost:1234 caddy run
+```
+
+# Build the docs
+
+## Without docker:
+### Prerequsites:
+* composer v2
+* PHP with ext-http and ext-dom
+* GNU make
+
+```sh
+make
+```
+
+## With docker:
+### Prerequisites:
+* docker-compose
+* your UID in docker-composer.yml
+* GNU make
+
+```sh
+make COMPOSER="docker-compose run --rm composer" \
+       PHP="docker-compose run --rm --entrypoint php composer"
+```
+
+# Release procedure
+
+1. create tag
+2. rebuild docs
+3. review docs
+4. commit
+5. move tag
+6. push