aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8e00de1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# bevy_terminal_dialog
+> [!WARNING]
+> This library is highly experimental and not intended for use by literally anyone ever. I will eventually clean this readme up, but for now don't worry about it.
+
+## Compatibility
+
+| Crate Version | Bevy Version |
+|--- |--- |
+| 0.1 | 0.14 |
+
+## Installation
+
+If enough people (like literally 1 person) want this on crates.io I'll consider putting it up there, but for now just add the GitHub URL to your `Cargo.toml`:
+
+```toml
+[dependencies.bevy_terminal_dialog]
+git = "https://github.com/exvacuum/bevy_terminal_dialog"
+```
+
+## License
+
+This crate is licensed under your choice of 0BSD, Apache-2.0, or MIT license.