Revise CLI Helper documentation: Expand overview, highlight key features, and improve...
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Mon, 26 Jan 2026 21:23:45 +0000 (23:23 +0200)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Mon, 26 Jan 2026 21:23:45 +0000 (23:23 +0200)
doc/index.org

index 9adfd45..ceec8bc 100644 (file)
 :PROPERTIES:
 :ID:       fef7ebc3-0f00-4b82-a926-c0cfdf709762
 :END:
-- See also: [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][CLI Helper JavaDoc]]
 
-This is library intended to facilitate creation of commandline
-applications in Java programming language. Library is packaged as an
-artifact to Maven repository. This makes it simple to add library as
-dependency to your project.
-
-Library provides following general functionalities:
-- [[id:4fca35e4-fdf1-4675-a36f-6206d6fb72cb][Asking for user input]]
-- [[id:eb7d5632-6152-4d37-8e55-1cf4da21c204][Commandline arguments processing]]
+CLI Helper is a Java library designed to reduce the boilerplate code
+typically required when building command-line applications. Instead of
+manually handling user input validation, default values, or complex
+argument parsing, *CLI Helper* provides straightforward methods that
+handle these tasks automatically, allowing developers to focus on
+their application's core functionality.
+
+Key features include:
+- [[id:4fca35e4-fdf1-4675-a36f-6206d6fb72cb][Interactive user input helpers]] that validate ranges, enforce
+  constraints, and provide clear prompts (e.g., asking for a number
+  between 1-100 or a file path that exists).
+- [[id:eb7d5632-6152-4d37-8e55-1cf4da21c204][A powerful command-line argument parser]] that supports subcommands,
+  options with parameters, and built-in validation for files,
+  directories, and data types.
+- Simple integration via Maven, with comprehensive documentation and
+  examples to get started quickly.
+
+Whether you're creating a small utility or a sophisticated CLI tool,
+CLI Helper ensures your interface is intuitive, reliable, and easy to
+maintain — saving you time and reducing common errors.
+
+See also: [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][CLI Helper JavaDoc]]
 
 * User input helper
 :PROPERTIES: