Skip to content

Commit b665a52

Browse files
committed
better README
1 parent e26f3d8 commit b665a52

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,23 @@ An easy, SerialPort based, MicroPython REPL for micro controllers.
77
* **[Live Board Demo](https://webreflection.github.io/micro-repl/board/)**
88
* **[Live PyScript Demo](https://webreflection.github.io/micro-repl/mpy/)** which uses *MicroPython* on the browser to communicate with the boards 🤯
99

10-
Each demo has been successfully tested on both [Spike Prime](https://spike.legoeducation.com/prime/lobby/), [Raspberry Pi Pico and Pico W](https://www.raspberrypi.com/documentation/microcontrollers/raspberry-pi-pico.html) and [Adafruit PyPortal - CircuitPython](https://www.adafruit.com/product/4116) ( <sup><sub>up to the `help()` it should work in other boards too</sub></sup> ).
10+
### Supported Boards
11+
12+
It is very likely that your *MicroPython* based board works too but these have been manually, and personally, tested during the development of this module:
13+
14+
* [Spike Prime](https://spike.legoeducation.com/prime/lobby/)
15+
* [Raspberry Pi Pico and Pico W](https://www.raspberrypi.com/documentation/microcontrollers/raspberry-pi-pico.html)
16+
* [Adafruit PyPortal - CircuitPython](https://www.adafruit.com/product/4116)
17+
* [Arduino Nano ESP32](https://store.arduino.cc/products/nano-esp32)<br>
18+
<sup>I used `dfu-util -a 0 -d 0x2341:0x0070 -D ./ARDUINO_NANO_ESP32-X.app-bin` to install *MicroPython* on it: [app-bin downloaded](https://micropython.org/download/ARDUINO_NANO_ESP32/)</sup>
1119

1220
- - -
1321

1422
## Features
1523

16-
The currently maintained and developed export is `micro-repl/board` which supports the following features:
24+
The currently maintained and developed export is `micro-repl/serial` (*previously known as board*) which supports the following features:
1725

18-
* board `name` showed as soon as connected
26+
* board `name` showed as soon as connected and associated to the *board* instance
1927
* fully interactive *REPL* mode out of the box
2028
* tab completion works out of the box too
2129
* every *Control+X* combination just works
@@ -28,17 +36,18 @@ The currently maintained and developed export is `micro-repl/board` which suppor
2836
* all imports are dynamic so it's size is still minimal before its usage
2937
* `eval` method, if awaited and the end of the code has a reference, will return that value, if any, beside evaluating code without showing it on *REPL* shell
3038

31-
Please **note** `micro-repl/board` is going to be renamed as `micro-repl/serial` instead, to eventually allow `micro-repl/bt` and others within the same ease of use.
39+
The `micro-repl/board` alias still exists but it's now `micro-repl/serial` instead, to eventually allow `micro-repl/bt` and others within the same ease of use.
3240

3341
## How To / Documentation
3442

35-
The easiest way to use `micro-repl/serial` or `micro-repl/board` is via *CDN*:
43+
The easiest way to use `micro-repl/serial` is via *CDN*:
3644

3745
```html
3846
<script type="module">
3947
import Board from 'https://esm.run/micro-repl/serial';
4048
41-
const board = new Board({
49+
// either Board(...) or new Board(...)
50+
const board = Board({
4251
// all optionals
4352
baudRate: 9600, // defaults to 115200
4453
onconnect() { console.info('connected') },
@@ -128,7 +137,7 @@ Please also note this is not the same as `board.terminal.write(...)` because the
128137
129138
<sup><sub>**WARNING**</sub></sup>
130139
131-
Please note this module is experimental. The current exports might change if actually the *board* is the best option this module offers (and I am definitively leading toward this conclusion).
140+
Please note this module is experimental. The current exports might change if actually the *board* reference is the best option this module offers (and I am definitively leading toward this conclusion).
132141
133142
- - -
134143

0 commit comments

Comments
 (0)