diff --git a/rw-stream-sink/README.md b/rw-stream-sink/README.md index 1efdd0f5..6d54ed54 100644 --- a/rw-stream-sink/README.md +++ b/rw-stream-sink/README.md @@ -1,7 +1,8 @@ This crate provides the `RwStreamSink` type. It wraps around a `Stream + Sink` that produces -byte arrays, and implements `AsyncRead` and `AsyncWrite`. +and accepts byte arrays, and implements `AsyncRead` and `AsyncWrite`. Each call to `write()` will send one packet on the sink. Calls to `read()` will read from incoming packets. -> **Note**: This crate is mostly a utility crate and is not at all specific to libp2p. +> **Note**: Although this crate is hosted in the libp2p repo, it is purely a utility crate and +> not at all specific to libp2p. diff --git a/rw-stream-sink/src/lib.rs b/rw-stream-sink/src/lib.rs index 7992d857..b9de4e5f 100644 --- a/rw-stream-sink/src/lib.rs +++ b/rw-stream-sink/src/lib.rs @@ -22,12 +22,13 @@ //#![doc(include = "../README.md")] //! This crate provides the `RwStreamSink` type. It wraps around a `Stream + Sink` that produces -//! byte arrays, and implements `AsyncRead` and `AsyncWrite`. +//! and accepts byte arrays, and implements `AsyncRead` and `AsyncWrite`. //! //! Each call to `write()` will send one packet on the sink. Calls to `read()` will read from //! incoming packets. //! -//! > **Note**: This crate is mostly a utility crate and is not at all specific to libp2p. +//! > **Note**: Although this crate is hosted in the libp2p repo, it is purely a utility crate and +//! > not at all specific to libp2p. extern crate bytes; extern crate futures;