Update README and clap help

TheWaWaR · Jun 3, 2017 · a28b184 · a28b184
1 parent 99de664
commit a28b184
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -5,27 +5,30 @@
 
 ### Command Line Arguments
 ```
-Simple HTTP(s) Server 0.4.1
+Simple HTTP(s) Server 0.4.2
 
 USAGE:
-    simple-http-server [FLAGS] [OPTIONS] [root]
+    simple-http-server [FLAGS] [OPTIONS] [--] [root]
 
 FLAGS:
     -h, --help       Prints help information
     -i, --index      Enable automatic render index page [index.html, index.htm]
         --nocache    Disable http cache
-        --norange    Disable header::Range support (partial download)
+        --norange    Disable header::Range support (partial request)
         --nosort     Disable directory entries sort (by: name, modified, size)
     -u, --upload     Enable upload files (multiple select)
     -V, --version    Prints version information
 
 OPTIONS:
-    -a, --auth <auth>            HTTP Basic Auth (username:password)
-        --cert <cert>            TLS/SSL certificate (pkcs#12 format)
-        --certpass <certpass>    TLS/SSL certificate password
-        --ip <ip>                IP address to bind [default: 0.0.0.0]
-    -p, --port <port>            Port number [default: 8000]
-    -t, --threads <threads>      How many worker threads [default: 3]
+    -a, --auth <auth>               HTTP Basic Auth (username:password)
+        --cert <cert>               TLS/SSL certificate (pkcs#12 format)
+        --certpass <certpass>       TLS/SSL certificate password
+    -c, --compress <compress>...    Enable file compression: gzip/deflate
+                                        Example: -c=js,d.ts
+                                        Note: disabled on partial request!
+        --ip <ip>                   IP address to bind [default: 0.0.0.0]
+    -p, --port <port>               Port number [default: 8000]
+    -t, --threads <threads>         How many worker threads [default: 3]
 
 ARGS:
     <root>    Root directory

diff --git a/src/main.rs b/src/main.rs
@@ -153,7 +153,7 @@ fn main() {
              .multiple(true)
              .value_delimiter(",")
              .takes_value(true)
-             .help("Enable file compression: gzip/deflate (Note: disabled on partial request!)"))
+             .help("Enable file compression: gzip/deflate\n    Example: -c=js,d.ts\n    Note: disabled on partial request!"))
         .arg(clap::Arg::with_name("threads")
              .short("t")
              .long("threads")