add a no_std note in the README

stratum-mining · Dec 26, 2024 · e137377 · e137377
1 parent 2425377
commit e137377
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/protocols/v2/noise-sv2/README.md b/protocols/v2/noise-sv2/README.md
@@ -22,6 +22,12 @@ To include this crate in your project, run:
 cargo add noise_sv2
 ```
 
+This crate can be built with the following feature flags:
+
+- `std`: Enable usage of rust `std` library, enabled by default.
+
+In order to use this crate in a `#![no_std]` environment, use the `--no-default-features` to remove the `std` feature.
+
 ### Examples
 
 This crate provides example on establishing a secure line: