From 3db7631a7d72ece3925d43a3f8cbaf1d1dba9e26 Mon Sep 17 00:00:00 2001 From: Kevin Donahue Date: Sat, 21 Sep 2019 13:57:38 -0400 Subject: [PATCH] create readme in examples directory --- examples/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..a4ff5ff3 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,23 @@ +# `async-std` Examples + +This directory contains example code that makes use of `async-std`. + +Each example can be run from the command line. + +For example, [Hello World][hello-world] can be run by running the following: + +``` +cargo run --example hello-world +``` + +- [Hello World][hello-world] + +Spawns a task that says hello. + +- [Line Count][line-count] + +Counts the number of lines in a file given as an argument. + +[hello-world]: https://github.com/async-rs/async-std/blob/master/examples/hello-world.rs +[line-count]: https://github.com/async-rs/async-std/blob/master/examples/line-count.rs +