docs: add warning

hasundue · Jun 4, 2024 · e961b7d · e961b7d
1 parent aa5c942
commit e961b7d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,9 @@
 A library to transform `describe` and `it` blocks in JavaScript/TypeScript into
 markdown documentation.
 
+> [!WARNING]\
+> Alpha version. Not tested extensively yet. APIs may change frequently.
+
 As an example, the usage below is generated from the actual tests with `bddoc`
 itself.
 

diff --git a/docs/template.md b/docs/template.md
@@ -3,6 +3,9 @@
 A library to transform `describe` and `it` blocks in JavaScript/TypeScript into
 markdown documentation.
 
+> [!WARNING]\
+> Alpha version. Not tested extensively yet. APIs may change frequently.
+
 As an example, the usage below is generated from the actual tests with `bddoc`
 itself.