dusk: add experimental warning

Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2023-04-05 03:07:34 -07:00
parent b649bc4ad6
commit d0af189182

View file

@ -2,6 +2,14 @@
This repository is a separate copy of the same library in the [main Mach repository](https://github.com/hexops/mach), and is automatically kept in sync, so that anyone can use this library in their own project if they like!
## Experimental
This is an _experimental_ Mach library, according to our [stability guarantees](https://machengine.org/next/docs/libs/):
> Experimental libraries may have their APIs change without much notice, and you may have to look at recent changes in order to update your code.
[Why this library is not declared stable yet](https://machengine.org/next/docs/libs/experimental/#dusk)
## Current Status
Dusk is in **very early stages** and under heavy development; there are hundreds of known bugs/missing features.