Skip to content

Commit 8e496ed

Browse files
committed
update readme
1 parent 9e52396 commit 8e496ed

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If you have questions or would like to chat, feel free to hop over to our discor
2828
## Getting Started
2929

3030
The components in this repository are targeted towards ESP-IDF >=5.0, though
31-
they are mainly tested against 5.2 right now.
31+
they are mainly tested against 5.4 right now.
3232

3333
To use the components in this repository, you have a few options:
3434

@@ -38,7 +38,31 @@ To use the components in this repository, you have a few options:
3838
submodule, along with the appropriate configuration in the top-level
3939
CMakeLists.txt.
4040

41-
2. If you have an existing project with a `components` directory, then you can
41+
1. You can add dependencies on the components you want using the `idf component
42+
manager`. All `espp` components are published to the [ESP Component
43+
Registry](https://components.espressif.com) under the namespace `esp-cpp`.
44+
45+
For example, if you want to use the `task` component and the
46+
`ble_gatt_server` components, you could run:
47+
48+
```console
49+
idf.py add-dependency "esp-cpp/task^0.20.2"
50+
idf.py add-dependency "esp-cpp/ble_gatt_server^0.20.2"
51+
```
52+
53+
Alternatively, you could add the following dependencies to your
54+
`main/idf_component.yml`:
55+
56+
```yaml
57+
dependencies:
58+
esp-cpp/ble_gatt_server:
59+
version: '>=0.20.2'
60+
esp-cpp/task:
61+
version: '>=0.20.2'
62+
# other dependencies here...
63+
```
64+
65+
1. If you have an existing project with a `components` directory, then you can
4266
clone `espp` as a submodule within that directory e.g. `git submodule add
4367
https://github.com/esp-cpp/espp components/espp`, then make sure to run `git
4468
submodule update --init --recursive`. Afterwards, simply update your
@@ -51,13 +75,10 @@ To use the components in this repository, you have a few options:
5175
)
5276
```
5377

54-
3. You can clone espp somewhere on your computer and then point your project to
78+
1. You can clone espp somewhere on your computer and then point your project to
5579
its `components` directory to use any of the components it contains, similar
5680
to the step above.
5781

58-
In the future (as part of #312), we may publish espp components (or even the
59-
whole espp repo) as an IDF component via the idf-component-registry.
60-
6182
## Additional Information and Links
6283

6384
* [Documentation](https://esp-cpp.github.io/espp/) - github hosted version of

0 commit comments

Comments
 (0)