Added toggle for 'repointing' as well as (slightly) better documentation and homepage

2024-09-19 21:37:51 +01:00 · 2024-09-19 21:37:51 +01:00 · 65c5023ae4
commit 65c5023ae4
parent dc48d44400
5 changed files with 85 additions and 9 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,15 @@
 # Motto

-Static file beautifier
+Motto presents files from a static file server in a more friendly way
+
+## Documentation
+
+### Configuration
+
+- `ROOT_URL=(url)` - the static file server instance to get files from
+- `ENABLE_REPOINTING=(true|default:false)` - enable [repointing](#Repointing)
+
+### Repointing
+
+If enabled, repointing allows a url to be specified in the `root` query parameter that will override
+the default url of the static file server