Skip to content

Commit

Permalink
Update README.md to mention smol-macros
Browse files Browse the repository at this point in the history
  • Loading branch information
junderw authored and notgull committed Aug 23, 2024
1 parent 2b1e6f7 commit d328e57
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ This crate simply re-exports other smaller async crates (see the source).
To use tokio-based libraries with smol, apply the [`async-compat`] adapter to futures and I/O
types.

See the [`smol-macros`] crate if you want a no proc-macro, fast compiling, easy-to-use
async main and/or multi-threaded Executor setup out of the box.

## Examples

Connect to an HTTP website, make a GET request, and pipe the response to the standard output:
Expand All @@ -42,9 +45,9 @@ fn main() -> io::Result<()> {

There's a lot more in the [examples] directory.

[`async-compat`]: https://docs.rs/async-compat
[`async-compat`]: https://docs.rs/async-compat/latest/async_compat/
[`smol-macros`]: https://docs.rs/smol-macros/latest/smol_macros/
[examples]: https://github.com/smol-rs/smol/tree/master/examples
[get-request]: https://github.com/smol-rs/smol/blob/master/examples/get-request.rs

## Subcrates

Expand Down

0 comments on commit d328e57

Please sign in to comment.