Skip to content

Commit 6b0b9af

Browse files
authored
fix(doc): fixing documentation apresentation
Fixes the documentation first paragraph in order to make it easier fore reading. It also displays in the very top which SoC are supported by the library.
1 parent 176f92b commit 6b0b9af

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

libraries/OpenThread/README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
1+
| Supported Targets | ESP32-C6 | ESP32-H2 |
2+
| ----------------- | -------- | -------- |
3+
14
# ESP32 Arduino OpenThreadCLI
25

3-
The `OpenThreadCLI` class is an Arduino API for interacting with the OpenThread Command Line Interface (CLI). It allows you to manage and configure the Thread stack using a command-line interface. Below are the details of the class:
4-
The available OpenThread Commands are documented in the [OpenThread CLI Reference Page](https://openthread.io/reference/cli/commands)
6+
The `OpenThreadCLI` class is an Arduino API for interacting with the OpenThread Command Line Interface (CLI). It allows you to manage and configure the Thread stack using a command-line interface.
57

6-
There is one main class called `OpenThreadCLI` and a global object used to operate OpenThread CLI, called `OThreadCLI`
8+
There is one main class called `OpenThreadCLI` and a global object used to operate OpenThread CLI, called `OThreadCLI`.\
79
Some [helper functions](helper_functions.md) were made available for working with the OpenThread CLI environment.
810

11+
The available OpenThread Commands are documented in the [OpenThread CLI Reference Page](https://openthread.io/reference/cli/commands)
12+
913
It is important to note that the current implementation can only be used with Espressif SoC that has support to IEEE 802.15.4, such as **ESP32-C6** and **ESP32-H2**.
1014

15+
Below are the details of the class:
16+
1117
## Class Definition
1218

1319
```cpp

0 commit comments

Comments
 (0)