Skip to content

Commit

Permalink
docs(readme): mention unstable feature flags in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jcornaz committed Nov 1, 2023
1 parent 7b4b2e0 commit 30cf0a0
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ cargo add impacted
* `std` (enabled by default) Allow to use rust the standard library (need to be disabled for `no_std` apps)
* `bvh-arena` Integration with [bvh-arena](https://crates.io/crates/bvh-arena) bounding volumes

## Unstable feature flags

**The following features may receive breaking changes or be removed in a patch release!**

* `unstable-v3` `v3` module, an exploration of what could be the next major version of the API
* `unstable-v3-aabb` Axis-Aligned-Bounding-Box shape for the v3 module



## MSRV

Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
//!
//! ## Unstable feature flags
//!
//! The following features may receive breaking changes or be removed in a patch release.
//! **The following features may receive breaking changes or be removed in a patch release!**
//!
//! * `unstable-v3` `v3` module, an exploration of what could be the next major version of the API
//! * `unstable-v3-aabb` Axis-Aligned-Bounding-Box shape for the v3 module
Expand Down

0 comments on commit 30cf0a0

Please sign in to comment.