Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sophiebremer committed Jun 4, 2023
1 parent 2225759 commit 6bc5d53
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,35 @@ other files to web browsers.



Example
-------
Examples
--------

``` Shell
cd html
npx svr
```

*or*

``` Shell
npx svr --root html
```



Options
-------

- `--cgi [path]`: Activates CGI path for web browsers.

- `--http [port]`: Activates HTTP port. Port number is optional.

- `--https [port]`: Activates HTTPS port. Port number is optional.

- `--https-cert [file]`: File path to the HTTPS certificate.

- `--https-key [file]`: File path to the HTTPS key.

- `--root [folder]`: Root folder with files for web browsers.

- `--timeout [seconds]`: Stops the server after the given amount of seconds.

0 comments on commit 6bc5d53

Please sign in to comment.