Skip to content

Commit b23a094

Browse files
committedFeb 17, 2020
README: add brief examples on how to use the quiche apps
1 parent 040e92c commit b23a094

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed
 

‎README.md

+25
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,31 @@ blog that goes into some more detail.
2525
Getting Started
2626
---------------
2727

28+
### Command-line apps
29+
30+
Before diving into the quiche API, here are a few examples on how to use the
31+
quiche tools provided as part of the [quiche-apps](tools/apps/) crate.
32+
33+
The client can be run as follows:
34+
35+
```bash
36+
$ cargo run --manifest-path=tools/apps/Cargo.toml --bin quiche-client -- https://quic.tech:8443/
37+
```
38+
39+
while the server can be run as follows:
40+
41+
```bash
42+
$ cargo run --manifest-path=tools/apps/Cargo.toml --bin quiche-server -- \
43+
--cert tools/apps/src/bin/cert.crt \
44+
--key tools/apps/src/bin/cert.key
45+
```
46+
47+
(note that the certificate provided is self-signed and should not be used in
48+
production)
49+
50+
Use the `--help` command-line flag to get a more detailed description of each
51+
tool's options.
52+
2853
### Connection setup
2954

3055
The first step in establishing a QUIC connection using quiche is creating a

0 commit comments

Comments
 (0)
Please sign in to comment.