From cf3d66143d0fa14e0e55d26ebcb109026fc5ee4e Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Thu, 15 Aug 2019 15:27:25 +0200 Subject: [PATCH 1/2] Rearrange README and fix typos --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6065709..0a7a350 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,14 @@ https://github.com/async-rs/async-std) [![Documentation](https://docs.rs/async-std/badge.svg)](https://docs.rs/async-std) [![chat](https://img.shields.io/discord/598880689856970762.svg?logo=discord)](https://discord.gg/JvZeVNe) -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. - -For detailed information, take a look at the [documentation][docs] and the associated [book][book]. +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. [`std`]: https://doc.rust-lang.org/std/index.html + +## Documentation + +`async-std` comes with [extensive API domentation][docs] and a [book][book]. + [docs]: https://docs.rs/async-std [book]: https://book.async.rs From 228f22440cb8dcc6f61ef9219fd1212547089db8 Mon Sep 17 00:00:00 2001 From: Florian Gilcher Date: Thu, 15 Aug 2019 15:33:45 +0200 Subject: [PATCH 2/2] Link to the book from lib.rs --- src/lib.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 2cefbc9..ad1b0e4 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,8 +1,12 @@ //! Async version of the Rust standard library. //! //! This crate is an async version of [`std`]. +//! Higher-level documentation in the form of the book +//! ["Async programming in Rust with async-std"][book] +//! is available. //! //! [`std`]: https://doc.rust-lang.org/std/index.html +//! [here]: https://book.async.rs //! //! # Examples //!