Skip to content

Commit c765d2e

Browse files
committed
add HTTP2 usage synopsis to readme
1 parent 4535383 commit c765d2e

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Features:
2323

2424
* Modular, extensible and easy to personalise. Create, share and consume only plugins which match your requirements.
2525
* Powerful, extensible command-line interface (add your own commands and options)
26-
* HTTP, HTTPS and experimental HTTP2 support
26+
* HTTP, HTTPS and HTTP2 support (HTTP2 requires node v8.4.0 or above)
2727
* URL Rewriting to local or remote destinations
2828
* Single Page Application support
2929
* Response mocking
@@ -230,6 +230,15 @@ $ ws --https
230230
Serving at https://mbp.local:8000, https://127.0.0.1:8000, https://192.168.0.100:8000
231231
```
232232
233+
### HTTP2
234+
235+
Uses node's built-in HTTP2 support. HTTP2 servers are always secure using local-web-server's built-in SSL certificates (by default) or those supplied by `--cert`, `--key` or `--pfx`. [See the wiki](https://github.com/lwsjs/local-web-server/wiki) for further info about HTTPS options and a guide on how to get the "green padlock" in your browser.
236+
237+
```sh
238+
$ ws --http2
239+
Serving at https://mbp.local:8000, https://127.0.0.1:8000, https://192.168.0.100:8000
240+
```
241+
233242
## Further Documentation
234243
235244
[See the wiki for plenty more documentation and tutorials](https://github.com/lwsjs/local-web-server/wiki).

0 commit comments

Comments
 (0)