Add configuration snippet to showcase env vars
[m6w6/gh-mirror] / README.md
index 9c604aa6c4fc39ec9bbcbcc0d29d1dd770f29378..6c3c7925b48ce39e6ad5268f100b05588e9710cd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,15 @@ Simple PHP webhook to mirror github repositories.
 
 ## Requirements
 
-* [pecl/http](/m6w6/ext-http)
+* [pecl/http](https://github.com/m6w6/ext-http)
+
+## Configuration
+
+```php
+$mirror = getenv("mirror") ?: "/var/github/mirror";
+$secret = getenv("secret") ?: trim(file_get_contents("$mirror/.secret"));
+$owners = explode(",", getenv("owners") ?: trim(file_get_contents("$mirror/.owners")));
+```
 
 ## License