Update CLI Helper library version in documentation

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

diff --git a/doc/index.org b/doc/index.org
index dde84b2..6fa1f18 100644 (file)
--- a/doc/index.org
+++ b/doc/index.org
@@ -20,23 +20,24 @@
 - [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary][Browse Git repository online]]
 
 - Clone Git repository using command:
-  : git clone https://www2.svjatoslav.eu/git/cli-helper.git
+  : git clone https://www3.svjatoslav.eu/git/cli-helper.git
 
 - See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]]
 
-* Library contents
+* Overview
 :PROPERTIES:
 :ID:       fef7ebc3-0f00-4b82-a926-c0cfdf709762
 :END:
-- See also: [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][CLI Helper JavaDoc]].
+- See also: [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][CLI Helper JavaDoc]]
 
-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:
+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:46115263-ed3d-4acc-9ec5-523d7acf87b8][Commandline interface arguments processing]]
+- [[id:46115263-ed3d-4acc-9ec5-523d7acf87b8][Commandline arguments processing]]
 
 ** Ask for user input
 :PROPERTIES:
@@ -47,6 +48,10 @@ such as:
 - askLong() :: Asks the user to enter an integer.
 - askString() :: Asks the user to enter a string.
 
+* Alternatives and further reading
+
+- [[https://clig.dev/][Command Line Interface Guidelines]]
+
 * Getting the library
 Instructions to embed svjatoslav-commons library in your project:
 
@@ -58,7 +63,7 @@ Maven pom.xml file snippet:
     <dependency>
         <groupId>eu.svjatoslav</groupId>
         <artifactId>cli-helper</artifactId>
-        <version>1.0</version>
+        <version>1.2</version>
     </dependency>
     ...
 </dependencies>
@@ -74,3 +79,25 @@ Maven pom.xml file snippet:
     ...
 </repositories>
 #+END_SRC
+* TODO:
+
+List of improvement suggestions:
+
+- Add more concrete examples of how to use the library in JavaDoc
+  comments. This will help developers quickly get started and learn
+  the API.
+
+- Provide more comprehensive unit tests for CliHelper,
+  ParameterParser, Options and subclasses. This will ensure robustness
+  and stability.
+
+- Add JavaDoc comments to all classes and methods where
+  applicable. This will provide better visibility into the library's
+  functionality for developers.
+
+- Add more option types like date/time, regular expression etc.
+
+- Document best practices for using the library in a larger project.
+
+- Implement support for more complex CLI applications like option
+  dependencies and conflicts resolution.