From 5691ac930fd6547c3f0166b64ead0ae647c38883 Mon Sep 17 00:00:00 2001 From: Timon Vonk Date: Tue, 9 Jul 2024 16:37:39 +0200 Subject: [PATCH] docs(README): add preproduction warning --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 1d15b43c..74b5161b 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,9 @@ Part of the [bosun.ai](https://bosun.ai) project. An upcoming platform for auton We <3 feedback: project ideas, suggestions, and complaints are very welcome. Feel free to open an issue. +> [!CAUTION] +> Swiftide is under heavy development and can have breaking changes while we work towards 1.0. Documentation here might fall short of all features, and despite our efforts be slightly outdated. Expect bugs. We recommend to always keep an eye on our [github](https://github.com/bosun-ai/swiftide) and [api documentation](https://docs.rs/swiftide/latest/swiftide/). If you found an issue or have any kind of feedback we'd love to hear from you in an issue. +

(back to top)

## Example