Add CLI arguments processing documentation

[cli-helper.git] / doc / index.org

diff --git a/doc/index.org b/doc/index.org
index ea82e8d..dde84b2 100644 (file)
--- a/doc/index.org
+++ b/doc/index.org
@@ -1,3 +1,6 @@
+:PROPERTIES:
+:ID:       bb4f96cd-458c-495b-a605-313b2e3e28d2
+:END:
 #+TITLE: CLI Helper - library to help implementing commandline interfaces
 
 * General
@@ -22,16 +25,30 @@
 - See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]]
 
 * Library contents
-- See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
+:PROPERTIES:
+:ID:       fef7ebc3-0f00-4b82-a926-c0cfdf709762
+:END:
+- See also: [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][CLI Helper JavaDoc]].
 
-- Commandline Interface helper
-  : eu.svjatoslav.commons.cli_helper.CLIHelper
+This library is a collection of command-line interface (CLI) helper
+functions that simplifies the process of building and maintaining CLI
+applications. The library provides several different functionalities,
+such as:
 
-- Commandline arguments parser and validator.
-  : eu.svjatoslav.commons.cli_helper.parameter_parser
+- [[id:4fca35e4-fdf1-4675-a36f-6206d6fb72cb][Asking for user input]]
+- [[id:46115263-ed3d-4acc-9ec5-523d7acf87b8][Commandline interface arguments processing]]
 
-* Usage
-Instructions to embed svjatoslav-commons in your project as a library:
+** Ask for user input
+:PROPERTIES:
+:ID:       4fca35e4-fdf1-4675-a36f-6206d6fb72cb
+:END:
+
+- askBoolean() :: Asks the user to enter a boolean value (yes/no).
+- askLong() :: Asks the user to enter an integer.
+- askString() :: Asks the user to enter a string.
+
+* Getting the library
+Instructions to embed svjatoslav-commons library in your project:
 
 Maven pom.xml file snippet: