docs: update docs for cli, env

soulteary · May 30, 2022 · a17a14d · a17a14d
1 parent 7263adb
commit a17a14d
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,25 @@ Currently supported data sources:
 - Project: https://github.com/AdguardTeam/AdGuardSDNSFilter/
   - file: https://adguardteam.github.io/AdGuardSDNSFilter/Filters/filter.txt
 
+## CLI && ENV
+
+CLI parameters:
+
+```bash
+  --debug      enable debug mode
+  --port int   web port (default 8345)
+```
+
+usage: `./hbh --port=8345 --debug=false`
+
+Env variables:
+
+```bash
+HBH_DEBUG=true
+HBH_PORT=1024
+```
+
+usage: `HBH_DEBUG=true HBH_PORT=1024 ./hbh`
 
 ## APIs && Pages