feat: Add first modules

This adds the first modules blocks from the initial proof of concept, with basic docs. Currently missing is bundling and usage instructions
2023-02-15 00:19:14 +01:00
parent c25f947416
commit 762ae97a36
15 changed files with 920 additions and 2 deletions
@@ -1,16 +1,27 @@
 bash-tui-toolkit
 ===
+[![pre-commit](https://img.shields.io/badge/%E2%9A%93%20%20pre--commit-enabled-success)](https://pre-commit.com/)

 Toolkit to create simple Terminal UIs using plain bash builtins

+> :warning: Currently, WIP and not in a stable state for usage
+
 ## Goals
+
 - provide a simple and clear default set of elements to use creating an interactive terminal UI
 - be clean and minimalistic
 - zero dependencies to be installed
- parts can be used seperately
+- parts can be used separately

 ## Install
+
 > tbd

 ## Documentation
-> tbd
+
+For a list of available modules and their documentation please check the [docs/modules](./docs/modules) folder
+
+## Alternatives
+
+- [kahkhang/Inquirer.sh](https://github.com/kahkhang/Inquirer.sh) - List, Checkbox and Text Input with more advanced
+  validation