From 6d0835ffe8c8b7aa461f39343cef3e3a82e7cb95 Mon Sep 17 00:00:00 2001 From: Saksham Singh <60515013+wayiam@users.noreply.github.com> Date: Mon, 9 Aug 2021 01:24:11 +0530 Subject: [PATCH] Used table format for README summary of commands. --- README.md | 73 ++++++++++++++++++++----------------------------------- 1 file changed, 26 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index a43f980b..26a54807 100644 --- a/README.md +++ b/README.md @@ -42,53 +42,32 @@ Using `npx` you can run the script without installing it first: ## Available Options: -`-p` or `--port` Port to use (defaults to 8080). Use `-p 0` to look for an open port, starting at 8080. It will also read from `process.env.PORT`. - -`-a` Address to use (defaults to 0.0.0.0) - -`-d` Show directory listings (defaults to `true`) - -`-i` Display autoIndex (defaults to `true`) - -`-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. If brotli is also enabled, it will try to serve brotli first. - -`-b` or `--brotli` When enabled (defaults to `false`) it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first. - -`-e` or `--ext` Default file extension if none supplied (defaults to `html`) - -`-s` or `--silent` Suppress log messages from output - -`--cors` Enable CORS via the `Access-Control-Allow-Origin` header - -`-o [path]` Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/ - -`-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`. - -`-U` or `--utc` Use UTC time format in log messages. - -`--log-ip` Enable logging of the client's IP address (default: `false`). - -`-P` or `--proxy` Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com - -`--username` Username for basic authentication [none] - -`--password` Password for basic authentication [none] - -`-S` or `--ssl` Enable https. - -`-C` or `--cert` Path to ssl cert file (default: `cert.pem`). - -`-K` or `--key` Path to ssl key file (default: `key.pem`). - -`-r` or `--robots` Provide a /robots.txt (whose content defaults to `User-agent: *\nDisallow: /`) - -`--no-dotfiles` Do not show dotfiles - -`--mimetypes` Path to a .types file for custom mimetype definition - -`-h` or `--help` Print this list and exit. - -`-v` or `--version` Print the version and exit. +| Command | Description | +| ------------- |:-------------:| +| `-p` or `--port` | Port to use (defaults to 8080). Use `-p 0` to look for an open port, starting at 8080. It will also read from `process.env.PORT`. | +| `-a` | Address to use (defaults to 0.0.0.0) | +| `-d` | Show directory listings (defaults to `true`) | +| `-i` | Address to use (defaults to 0.0.0.0) | +| `-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. If brotli is also enabled, it will try to serve brotli first.| +| `-b` or `--brotli`| When enabled (defaults to `false`) it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first. | +| `-e` or `--ext` | Default file extension if none supplied (defaults to `html`) | +| `-s` or `--silent` | Suppress log messages from output | +| `--cors` | Enable CORS via the `Access-Control-Allow-Origin` header | +| `-o [path]` | Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/ | +| `-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`.| +| `-U` or `--utc` | Use UTC time format in log messages.| +| `--log-ip` | Enable logging of the client's IP address (default: `false`). | +| `-P` or `--proxy` | Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com | +| `--username` | Username for basic authentication [none] | +| `--password` | Password for basic authentication [none] | +| `-S` or `--ssl` | Enable https.| +| `-C` or `--cert` | Path to ssl cert file (default: `cert.pem`). | +|`-K` or `--key` | Path to ssl key file (default: `key.pem`). | +| `-r` or `--robots` | Provide a /robots.txt (whose content defaults to `User-agent: *\nDisallow: /`) | +| `--no-dotfiles` | Do not show dotfiles +| `--mimetypes` |Path to a .types file for custom mimetype definition +| `-h` or `--help` | Print this list and exit. | +| `-v` or `--version`| Print the version and exit. | ## Magic Files