diff --git a/README.md b/README.md index aa4c7c319c9..e48632b849f 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ If you have any questions, comments, or concerns, please [open an issue], [start > [!NOTE] > -> This project is still in the relatively early stages of development, and as such there should be no expectation of API stability. A significant number of peripherals currently have drivers implemented but have varying levels of functionality. For most tasks, this should be usable already, however some more advanced or uncommon features may not yet be implemented. +> This project is still in the relatively early stages of development. A significant number of peripherals currently have drivers implemented but have varying levels of functionality. For most tasks, this should be usable already, however some more advanced or uncommon features may not yet be implemented. [esp-lp-hal]: https://github.com/esp-rs/esp-hal/tree/main/esp-lp-hal [esp-idf-svc]: https://github.com/esp-rs/esp-idf-svc diff --git a/esp-hal/README.md b/esp-hal/README.md index 5a5eaf844af..86d1432cc86 100644 --- a/esp-hal/README.md +++ b/esp-hal/README.md @@ -46,6 +46,12 @@ For help getting started with this HAL, please refer to [The Rust on ESP Book] a [s2-trm]: https://www.espressif.com/sites/default/files/documentation/esp32-s2_technical_reference_manual_en.pdf [s3-trm]: https://www.espressif.com/sites/default/files/documentation/esp32-s3_technical_reference_manual_en.pdf +## `unstable` feature + +We aim to avoid enabling experimental features automatically. Allowing automatic access could result in users unintentionally utilizing APIs that are still under development. + +This feature is **NOT** enabled by default. + ## Minimum Supported Rust Version (MSRV) This crate is guaranteed to compile on stable Rust 1.83 and up. It _might_