Merge pull request #13 from spod/topic/README_cargo_run_examples

Add readme instructions on running examples with cargo ...
oblique · Jan 1, 2021 · 1cb44ce · 1cb44ce
2 parents a7c8190 + 5950942
commit 1cb44ce
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -50,6 +50,22 @@ smol = "1" # or any other runtime/executor
 async-tftp = "0.3"
 ```
 
+## Running examples with cargo
+
+There are some examples included with this crate.
+You can run them from a source checkout with cargo:
+
+```bash
+$ cargo run --example tftpd-dir
+TFTP directory: ...
+Listening on: 0.0.0.0:6969
+^C
+
+$ cargo run --example tftpd-targz <archive-path>
+Listening on: 0.0.0.0:6969
+^C
+```
+
 # License
 
 [MIT][license]