Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to mention smol-macros #319

Merged
merged 2 commits into from
Aug 23, 2024
Merged

Update docs to mention smol-macros #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e236229
Update docs to mention smol-macros
junderw Aug 22, 2024
39c1953
Update README.md to mention smol-macros
junderw Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
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
7 changes: 5 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
//! 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 @@ -27,9 +30,9 @@
//!
//! 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

#![doc(
html_favicon_url = "https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png"
Expand Down
Loading