Updated latest released version number in documentation.
[svjatoslav_commons.git] / doc / index.org
index 4d7cb24..31277b8 100644 (file)
@@ -1,33 +1,67 @@
 #+TITLE: Svjatoslav Commons - Java library of commonly used functions
 
------
-- [[http://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]]
-
-- This program is free software; you can redistribute it and/or modify
-  it under the terms of version 3 of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public
-  License]] or later as published by the Free Software Foundation.
+* General
+- This program is free software: released under Creative Commons Zero
+  (CC0) license
 
 - Program author:
   - Svjatoslav Agejenko
-  - Homepage: http://svjatoslav.eu
+  - Homepage: https://svjatoslav.eu
   - Email: mailto://svjatoslav@svjatoslav.eu
 
-- [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
+- [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
 
-* General
-Library contains:
-- Wildcards matcher. (?, *)
+** Source code
+- [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
+
+- [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=summary][Browse Git repository online]]
+
+- Clone Git repository using command:
+  : git clone https://www2.svjatoslav.eu/git/svjatoslav_commons.git
+
+- See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
+
+* Library contents
+- See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
 
-- Commandline arguments parser and validator.
+- Bit input and output streams.
+  : eu.svjatoslav.commons.data.BitInputStream
+  : eu.svjatoslav.commons.data.BitOutputStream
+
+- Slightly enhanced data input and output streams.
+  : eu.svjatoslav.commons.data.EnhancedDataInputStream
+  : eu.svjatoslav.commons.data.EnhancedDataOutputStream
+
+- Byte array to HEX string converter.
+  : eu.svjatoslav.commons.data.HexConverter
+
+- Utility that tries to quess user desktop directory. (Quite ugly and
+  unreliable. Better solution is needed.)
+  : eu.svjatoslav.commons.file.CommonPathResolver
 
 - File path parser.
+  : eu.svjatoslav.commons.file.FilePathParser
+
+- File IO helper.
+  : eu.svjatoslav.commons.file.IOHelper
 
 - Graphical error dialog.
   - Reusable graphical dialog to capture and show program exceptions
     and associated program call stack traceback.
+    : eu.svjatoslav.commons.gui.dialog.ExceptionDialog
 
-- Primitive URL parameters encoder / decoder.
+- Primitive and simple component to add navigation menus to the web
+  sites.
+  : eu.svjatoslav.commons.network.navigation
 
+- String tokenizer.
+  : eu.svjatoslav.commons.string.tokenizer
+
+- Improved String, optimized for dealing with prefixes and suffixes.
+  : eu.svjatoslav.commons.string.String2
+
+- Wildcards matcher. (?, *)
+  : eu.svjatoslav.commons.string.WildCardMatcher#match
 
 * Usage
 Instructions to embed svjatoslav-commons in your project as a library:
@@ -40,7 +74,7 @@ Maven pom.xml file snippet:
     <dependency>
         <groupId>eu.svjatoslav</groupId>
         <artifactId>svjatoslavcommons</artifactId>
-        <version>1.4</version>
+        <version>1.9</version>
     </dependency>
     ...
 </dependencies>