docs: add a note about the experimental state

joshka · joshka · commit ba0e2b5827c5 · 2024-02-29T15:20:14.000-08:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Tui-markdown and Markdown-Reader
 
-A Ratatui library and TUI app for rendering Markdown
+An experimental Proof of Concept Ratatui library and TUI app for rendering Markdown
 
 - [Tui-markdown README](./tui-markdown/README.md)
 - [Markdown-reader README](./markdown-reader/README.md)
diff --git a/markdown-reader/README.md b/markdown-reader/README.md
@@ -8,8 +8,9 @@
 
 [GitHub Repository] · [Changelog] · [Contributing]
 
-A simple markdown reader that uses [Ratatui] to render markdown files. The primary purpose of this
-crate is to test the [tui-markdown] crate.
+An experimental Proof of Concept markdown reader that uses [Ratatui] to render markdown files. The
+primary purpose of this crate is to test the [tui-markdown] crate. It is not ready for any sort of
+real world use.
 
 ![Made with VHS](https://vhs.charm.sh/vhs-6Ur5mxqdVTizZxiAmgIjAE.gif)
 
diff --git a/tui-markdown/README.md b/tui-markdown/README.md
@@ -1,7 +1,7 @@
 # Tui-markdown
 
-A library for converting markdown content to a [Ratatui] `Text` value. See [Markdown-reader] for an
-example application that uses this library.
+An experimental Proof of Concept library for converting markdown content to a [Ratatui] `Text`
+value. See [Markdown-reader] for an example application that uses this library.
 
 [![Crate badge]][tui-markdown]
 [![Docs.rs Badge]][API Docs]
