From d0af189182e53db075e724274a0fafb42746417b Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Wed, 5 Apr 2023 03:07:34 -0700 Subject: [PATCH] dusk: add experimental warning Signed-off-by: Stephen Gutekanst --- libs/dusk/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/libs/dusk/README.md b/libs/dusk/README.md index 6ea2b00a..d525068c 100644 --- a/libs/dusk/README.md +++ b/libs/dusk/README.md @@ -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.