index : static-web-server.git

593ca98a192df95f0417372667f055b5ae35448e [patch]

6d9582932ddf50f1b1559cf80d0f2718934f7baa

3e64cbbeb8d20d3d805d5418657f2116937664b3

593ca98a192df95f0417372667f055b5ae35448e.tar.gz

docs: update readme info

Diff

 README.md | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index a562371..3a3abe0 100644
--- a/README.md
+++ b/README.md
@@ -31,13 +31,14 @@ Server is configured either via environment variables:
- **SERVER_PORT**: Host port. Default `80`.
- **SERVER_ROOT**: Root directory path of static files. Default `./public`.
- **SERVER_ASSETS**: Assets directory path for add cache headers functionality. Default `./assets` but relative to the root.
- **SERVER_ERROR_PAGE_404**: HTML file path for 404 errors. Default `./public/404.html`.
- **SERVER_ERROR_PAGE_50X**: HTML file path for 50x errors. Default `./public/50x.html`.
- **SERVER_ERROR_PAGE_404**: HTML file path for 404 errors. If path is not specified or simply don't exists then server will use a generic HTML error message. Default `./public/404.html`.
- **SERVER_ERROR_PAGE_50X**: HTML file path for 50x errors. If path is not specified or simply don't exists then server will use a generic HTML error message. Default `./public/50x.html`.

Or command line arguments listed with `cargo run -- -h`.

```sh
static-web-server 1.0.0
```
static-web-server 1.2.0
A blazing fast static files-serving web server powered by Rust Iron

USAGE:
    static-web-server [OPTIONS]
@@ -51,8 +52,12 @@ OPTIONS:
                               [default: ./assets]
        --host <host>          Host address (E.g 127.0.0.1) [env: SERVER_HOST=]  [default: [::]]
        --name <name>          Name for server [env: SERVER_NAME=]  [default: my-static-server]
        --page404 <page404>    HTML file path for 404 errors [env: SERVER_ERROR_PAGE_404=]  [default: ./public/404.html]
        --page50x <page50x>    HTML file path for 50x errors [env: SERVER_ERROR_PAGE_50X=]  [default: ./public/50x.html]
        --page404 <page404>    HTML file path for 404 errors. If path is not specified or simply don't exists then
                               server will use a generic HTML error message. [env: SERVER_ERROR_PAGE_404=]  [default:
                               ./public/404.html]
        --page50x <page50x>    HTML file path for 50x errors. If path is not specified or simply don't exists then
                               server will use a generic HTML error message. [env: SERVER_ERROR_PAGE_50X=]  [default:
                               ./public/50x.html]
        --port <port>          Host port [env: SERVER_PORT=]  [default: 80]
        --root <root>          Root directory path of static files [env: SERVER_ROOT=]  [default: ./public]
```