Skip to content

Commit 332c171

Browse files
committed
Improved readme.
1 parent 117188f commit 332c171

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1-
# 1. The MicroPython uasyncio library
1+
# 1. Asynchronous programming in MicroPython
22

3-
This repository comprises the following parts.
4-
1. A modified [fast_io](./FASTPOLL.md) version of `uasyncio`. This is a "drop
5-
in" replacement for the official version providing additional functionality.
6-
2. A module enabling the [fast_io](./FASTPOLL.md) version to run with very low
7-
power draw.
8-
3. Resources for users of official or [fast_io](./FASTPOLL.md) versions:
3+
CPython supports asynchronous programming via the `asyncio` library.
4+
MicroPython provides `uasyncio` which is a subset of this, optimised for small
5+
code size and high performance on bare metal targets. This repository provides
6+
documentation, tutorial material and code to aid in its effective use. It also
7+
contains an optional `fast_io` variant of `uasyncio`.
8+
9+
## The fast_io variant
10+
11+
This comprises two parts.
12+
1. The [fast_io](./FASTPOLL.md) version of `uasyncio` is a "drop in"
13+
replacement for the official version providing bug fixes, additional
14+
functionality and, in certain respects, higher performance.
15+
2. An optional extension module enabling the [fast_io](./FASTPOLL.md) version
16+
to run with very low power draw.
17+
18+
## Resources for users of all versions
919

1020
* [A tutorial](./TUTORIAL.md) An introductory tutorial on asynchronous
11-
programming and the use of the `uasyncio` library (asyncio subset).
21+
programming and the use of the `uasyncio` library.
1222
* [Asynchronous device drivers](./DRIVERS.md). A module providing drivers for
1323
devices such as switches and pushbuttons.
1424
* [Synchronisation primitives](./PRIMITIVES.md). Provides commonly used
@@ -35,7 +45,7 @@ This repository comprises the following parts.
3545

3646
# 2. Version and installation of uasyncio
3747

38-
Paul Sokolovsky (`uasyncio` author) has released `uasyncio` V2.4. This version
48+
Paul Sokolovsky (`uasyncio` author) has released `uasyncio` V2.2.1. This version
3949
is on PyPi and requires his [Pycopy](https://github.com/pfalcon/micropython)
4050
fork of MicroPython firmware. His `uasyncio` code may also be found in
4151
[his fork of micropython-lib](https://github.com/pfalcon/micropython-lib).

0 commit comments

Comments
 (0)