updated documentation

[svjatoslav_commons.git] / doc / index.org

diff --git a/doc/index.org b/doc/index.org
new file mode 100644 (file)
index 0000000..4d7cb24
--- /dev/null
+++ b/doc/index.org
@@ -0,0 +1,58 @@
+#+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.
+
+- Program author:
+  - Svjatoslav Agejenko
+  - Homepage: http://svjatoslav.eu
+  - Email: mailto://svjatoslav@svjatoslav.eu
+
+- [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
+
+* General
+Library contains:
+- Wildcards matcher. (?, *)
+
+- Commandline arguments parser and validator.
+
+- File path parser.
+
+- Graphical error dialog.
+  - Reusable graphical dialog to capture and show program exceptions
+    and associated program call stack traceback.
+
+- Primitive URL parameters encoder / decoder.
+
+
+* Usage
+Instructions to embed svjatoslav-commons in your project as a library:
+
+Maven pom.xml file snippet:
+
+#+BEGIN_SRC xml
+<dependencies>
+    ...
+    <dependency>
+        <groupId>eu.svjatoslav</groupId>
+        <artifactId>svjatoslavcommons</artifactId>
+        <version>1.4</version>
+    </dependency>
+    ...
+</dependencies>
+
+
+<repositories>
+    ...
+    <repository>
+        <id>svjatoslav.eu</id>
+        <name>Svjatoslav repository</name>
+        <url>http://www2.svjatoslav.eu/maven/</url>
+    </repository>
+    ...
+</repositories>
+#+END_SRC