diff --git a/CHANGELOG.md b/CHANGELOG.md index f8c3bae..edc02da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # 0.5.2 * Added SOCKS4 support `bind` and `connect`. +* `tokio` becomes an optional dependency and [`futures-io`](https://github.com/rust-lang/futures-rs/tree/0.3.30/futures-io) traits are supported through the `futures-io` feature. # 0.5.1 diff --git a/README.md b/README.md index 2f30106..cbf632b 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,11 @@ Asynchronous SOCKS proxy support for Rust. ## Compatibility with Other Async Runtimes -By default use `tokio` feature, as the crate name suggests. +By default, the `tokio` feature is enabled, as the crate name suggests. -Compatibility with `futures-io` can be enabled by enabling the `futures-io` feature -and `use tokio_socks::io::FuturesIoCompatExt`. +Users can opt out `tokio` by setting `default-features = false`. The `*_with_socket` functions accept types implementing the `AsyncSocket` trait. -When using `default-features = false` with `futures-io`, tokio is not pulled in as a dependency. +The crate provides `io::Compat` that implements `AsyncSocket` for `futures-io` types (requiring the `futures-io` feature). ## License