Skip to content

Commit 487ecdc

Browse files
authored
Merge pull request #29 from async-rs/link-to-book
Link to book
2 parents da10be5 + 228f224 commit 487ecdc

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,14 @@ https://github.com/async-rs/async-std)
77
[![Documentation](https://docs.rs/async-std/badge.svg)](https://docs.rs/async-std)
88
[![chat](https://img.shields.io/discord/598880689856970762.svg?logo=discord)](https://discord.gg/JvZeVNe)
99

10-
This crate provices an async version of [`std`]. It provides all the interfaces you are used to, but async and ready for Rusts `async/await`-syntax.
11-
12-
For detailed information, take a look at the [documentation][docs] and the associated [book][book].
10+
This crate provides an async version of [`std`]. It provides all the interfaces you are used to, but async and ready for Rusts `async/await`-syntax.
1311

1412
[`std`]: https://doc.rust-lang.org/std/index.html
13+
14+
## Documentation
15+
16+
`async-std` comes with [extensive API domentation][docs] and a [book][book].
17+
1518
[docs]: https://docs.rs/async-std
1619
[book]: https://book.async.rs
1720

src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
//! Async version of the Rust standard library.
22
//!
33
//! This crate is an async version of [`std`].
4+
//! Higher-level documentation in the form of the book
5+
//! ["Async programming in Rust with async-std"][book]
6+
//! is available.
47
//!
58
//! [`std`]: https://doc.rust-lang.org/std/index.html
9+
//! [here]: https://book.async.rs
610
//!
711
//! # Examples
812
//!

0 commit comments

Comments
 (0)