Addes documentation to examples (#348)
This commit is contained in:
parent
68389ac5b4
commit
b3cf303295
@ -24,6 +24,8 @@ The examples are compatible with the latest release.
|
||||
$ cargo run --example [file name]
|
||||
```
|
||||
|
||||
To run the interactive-demo go into the folder `examples/interactive-demo` and run `cargo run`.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.
|
||||
|
@ -1,6 +1,6 @@
|
||||
//! Demonstrates how to read events asynchronously with async-std.
|
||||
//!
|
||||
//! cargo run --example event-read-char-line
|
||||
//! cargo run --features="event-stream" --example event-stream-async-std
|
||||
|
||||
use std::{
|
||||
io::{stdout, Write},
|
||||
|
@ -1,6 +1,6 @@
|
||||
//! Demonstrates how to read events asynchronously with tokio.
|
||||
//!
|
||||
//! cargo run --features event-stream --example event-stream-tokio
|
||||
//! cargo run --features="event-stream" --example event-stream-tokio
|
||||
|
||||
use std::{
|
||||
io::{stdout, Write},
|
||||
|
@ -5,6 +5,8 @@
|
||||
//!
|
||||
//! This particular example is only suited to Unix
|
||||
//! for now.
|
||||
//!
|
||||
//! cargo run --example stderr
|
||||
|
||||
use std::io::{stderr, Write};
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user