Add nightly feature flag for Rust nightly-only functionality

1 files changed, 15 insertions, 0 deletions

diff --git a/ABOUT-NIGHTLY.md b/ABOUT-NIGHTLY.md
new file mode 100644
index 0000000..f2d4ec7
--- /dev/null
+++ b/ABOUT-NIGHTLY.md
@@ -0,0 +1,15 @@
+# About Nightly Rust
+
+**Mingling** uses some features that are only available in the `nightly` toolchain. This requires you to enable the `nightly` feature:
+
+```toml
+[dependencies]
+mingling = { version = "...", features = ["nightly"] }
+```
+
+## Features
+
+> [!WARNING]
+> The following features can only be used with the nightly toolchain, and are only guaranteed to compile, not to be stable or production-ready.
+>
+> If you need a stable development experience, please **do not use** the `nightly` feature!