readme and license

[whiptailexamples/.git] / README.md

diff --git a/README.md b/README.md
index a88ded295901367fc31b8adb82b226888415fae9..bc0a58d63a38bb5aff36fdfee5676eb1febeb342 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,10 @@
-# whiptailexamples
-whiptail examples
+# Whiptail Examples
+
+This is a fork that intends to be just a group of templates for the use of the
+whiptail command, which is a utility designed to make easy ncurses based TUI's
+
+## future plans
+This will incorporate examples from other TUI libraries like [charmbracelet's](https://github.com/charmbracelet/) [BubbleTea](https://github.com/charmbracelet/bubbletea)
+as well as other TUI's libraries like the ones on the libraries section of the
+[awesome-tui](https://github.com/rothgar/awesome-tuis "Lots of TUI programs") repo here on github.
+