about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4ef9637..4706872 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
 # faila2
 
-faila, but simpler. Throw this binary in a folder and it'll be hosted
\ No newline at end of file
+faila, but simpler. Throw this binary in a folder and it'll be hosted
+
+## Flags
+
+```bash
+$ ./faila2 -h
+Usage of faila2:
+  -dir string
+        path to host (default "./")
+  -ip string
+        ip to listen on (default "0.0.0.0")
+  -p string
+        port to listen on (default "8087")
+```
+
+## Redirects
+
+If you want to redirect to another page, create an `index.html` in the folder that should redirect with the following content:
+
+```html
+<meta http-equiv="refresh" content="N; URL=/testb">
+```
+
+replacing `/testb` with the place where you'd like to be redirected to