Browse Source

Update README.md

Vova Tkach 6 years ago
parent
commit
d2d2d9f2fa
1 changed files with 28 additions and 8 deletions
  1. 28 8
      README.md

+ 28 - 8
README.md

@@ -3,16 +3,36 @@
 ## Usage
 ```
 Usage of ./fave:
-	-debug
-		debug mode with ignoring log files
-	-dir string
-		virtual hosts directory
-	-host string
-		server host (default "0.0.0.0")
-	-port int
-		server port (default 8080)
+  -debug
+    debug mode with ignoring log files
+  -dir string
+    virtual hosts directory
+  -host string
+    server host (default "0.0.0.0")
+  -port int
+    server port (default 8080)
 ```
 
+## Hosts structure
+```
+hosts
+├── localhost        # Main host directory
+├──── config         # Config directory
+├────── mysql.json   # MySQL config file
+├──── htdocs         # Public http files
+├──── logs           # Logs dir
+├────── access.log   # Access log file
+├────── error.log    # Error log file
+├──── template       # Engine templates
+├────── footer.html  # Footer
+├────── header.html  # Header
+├────── index.html   # Template for index page
+├────── page.html    # Template for any other pages
+├────── sidebar.html # Can be included in templates
+└──── tmp            # Temporary dir for session files
+```
+Unlimited hosts count.
+
 ## Development
 * **make** - vet, test, build and run in debug mode locally
 * **make build** - build release for Linux, Mac OS X and Windows