From 35ad8a2a6eaba9ceaef9f3d136ccab17a90e8ca3 Mon Sep 17 00:00:00 2001 From: Juan Ibiapina Date: Wed, 22 May 2024 23:20:23 +0200 Subject: [PATCH] doc: Add description and key features section to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 6e7790c..e8b0f97 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ Organize groups of scripts into documented CLIs with subcommands. +`sub` is a tool designed to help organize groups of scripts into a command-line +interface (CLI) with subcommands. It allows the dynamic creation of a CLI from +a directory (and subdirectories) of scripts. + +## Key features + +- **Easy to setup**: A single command is required to setup. +- **Display help**: Display usage and documentation for scripts. +- **Validate arguments**: Validate arguments to scripts based on documentation. +- **Parse arguments**: Automatically parse arguments to scripts so getopts is not needed. +- **Nested subcommands**: Supports nested directories for hierarchical command structures. +- **Aliases**: Supports aliases for subcommands. +- **Cross-platform**: Works on Linux and macOS. + ## Overview `sub` is meant to be used as the entry point for a CLI. Given the following