Skip to content

Commit 9432968

Browse files
committed
Update README for cli switch value clarity
Booleans current MUST be lowercase. Improved Markdown for presenting cli values.
1 parent 9571d0a commit 9432968

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,33 +33,33 @@ This will install `http-server` globally so that it may be run from the command
3333

3434
`-a` Address to use (defaults to 0.0.0.0)
3535

36-
`-d` Show directory listings (defaults to 'True')
36+
`-d` Show directory listings (defaults to `true`)
3737

38-
`-i` Display autoIndex (defaults to 'True')
38+
`-i` Display autoIndex (defaults to `true`)
3939

40-
`-g` or `--gzip` When enabled (defaults to 'False') it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding.
40+
`-g` or `--gzip` When enabled (defaults to `false`) it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding.
4141

42-
`-e` or `--ext` Default file extension if none supplied (defaults to 'html')
42+
`-e` or `--ext` Default file extension if none supplied (defaults to `html`)
4343

4444
`-s` or `--silent` Suppress log messages from output
4545

4646
`--cors` Enable CORS via the `Access-Control-Allow-Origin` header
4747

4848
`-o` Open browser window after starting the server
4949

50-
`-c` Set cache time (in seconds) for cache-control max-age header, e.g. -c10 for 10 seconds (defaults to '3600'). To disable caching, use -c-1.
50+
`-c` Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds (defaults to `3600`). To disable caching, use `-c-1`.
5151

5252
`-U` or `--utc` Use UTC time format in log messages.
5353

5454
`-P` or `--proxy` Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com
5555

5656
`-S` or `--ssl` Enable https.
5757

58-
`-C` or `--cert` Path to ssl cert file (default: cert.pem).
58+
`-C` or `--cert` Path to ssl cert file (default: `cert.pem`).
5959

60-
`-K` or `--key` Path to ssl key file (default: key.pem).
60+
`-K` or `--key` Path to ssl key file (default: `key.pem`).
6161

62-
`-r` or `--robots` Provide a /robots.txt (whose content defaults to 'User-agent: *\nDisallow: /')
62+
`-r` or `--robots` Provide a /robots.txt (whose content defaults to `User-agent: *\nDisallow: /`)
6363

6464
`-h` or `--help` Print this list and exit.
6565

0 commit comments

Comments
 (0)