Skip to content

Commit eebedf9

Browse files
author
Stjepan Glavina
committed
Update readme
1 parent 556d883 commit eebedf9

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,13 @@ https://github.com/async-rs/async-task)
77
[![Documentation](https://docs.rs/async-task/badge.svg)](https://docs.rs/async-task)
88
[![chat](https://img.shields.io/discord/598880689856970762.svg?logo=discord)](https://discord.gg/JvZeVNe)
99

10-
A task abstraction for building executors.
10+
Task abstraction for building executors.
1111

12-
This crate makes it possible to build an efficient and extendable executor in few lines of
13-
code.
12+
To spawn a future onto an executor, we first need to allocate it on the heap and keep some
13+
state alongside it. The state indicates whether the future is ready for polling, waiting to be
14+
woken up, or completed. Such a future is called a *task*.
15+
16+
This crate helps with task allocation and polling its future to completion.
1417

1518
## License
1619

0 commit comments

Comments
 (0)