From 7ee554218208a9f3919d840079bd96c6ba881caf Mon Sep 17 00:00:00 2001
From: Alice Ryhl <alice@ryhl.io>
Date: Wed, 8 Jan 2020 00:55:10 +0100
Subject: doc: fix old notes regarding examples and async/await (#2071)

---
 examples/README.md | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

(limited to 'examples')

diff --git a/examples/README.md b/examples/README.md
index 802d0aa4..8217d4c6 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,6 +1,20 @@
 ## Examples of how to use Tokio
 
-The `master` branch is currently being updated to use `async` / `await`.
-The examples are not fully ported. Examples for stable Tokio can be
-found
-[here](https://github.com/tokio-rs/tokio/tree/v0.1.x/tokio/examples).
+This directory contains a number of examples showcasing various capabilities of
+the `tokio` crate.
+
+All examples can be executed with:
+
+```
+cargo run --example $name
+```
+
+A good starting point for the examples would be [`hello_world`](hello_world.rs)
+and [`echo`](echo.rs). Additionally [the tokio website][tokioweb] contains
+additional guides for some of the examples.
+
+If you've got an example you'd like to see here, please feel free to open an
+issue. Otherwise if you've got an example you'd like to add, please feel free
+to make a PR!
+
+[tokioweb]: https://tokio.rs/docs/overview/
-- 
cgit v1.2.3