Skip to content

Commit

Permalink
update readme about compat with other async runtimes
Browse files Browse the repository at this point in the history
  • Loading branch information
Congyuwang authored and sticnarf committed Jul 25, 2024
1 parent deb0e31 commit 16c02af
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ Asynchronous SOCKS proxy support for Rust.
- [X] Chain proxies ([see example](examples/chainproxy.rs))
- [X] SOCKS4

## Compatibility with Other Async Runtimes

By default use `tokio` feature, as the crate name suggests.

Compatibility with `futures-io` can be enabled by enabling the `futures-io` feature
and `use tokio_socks::io::FuturesIoCompatExt`.

When using `default-features = false` with `futures-io`, tokio is not pulled in as a dependency.

## License

This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.
Expand Down

0 comments on commit 16c02af

Please sign in to comment.