Merge branch 'master' into topic/miurahr/enable-header-crc-for-write

[dictzip-java/dictzip-java.git] / README.md

diff --git a/README.md b/README.md
index f131c1a..70e2368 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,67 @@
-# dictzip-java
+# dictzip
+
 DictZip, GZip random access compression format(.dz), access library for Java
 
-# license
+[![Build Status](https://travis-ci.org/dictzip/dictzip-java.svg?branch=master)](https://travis-ci.org/dictzip/dictzip-java)
+
+
+## Usage
+
+
+dictzip library is published on MavenCentral. When you use with gradle build system,
+just add a dependency.
+
+```
+dependencies {
+    implementation 'io.github.dictzip:dictzip:0.9.5'
+}
+```
+
+## Document
+
+There is a javadoc of DictZip at https://miurahr.github.io/dictzip-java
+
+
+## Contribution
+
+As usual of other projects hosted on GitHub, DictZip for java also welcome
+forking source and send modification as a Pull Request.
+It is recommended to post an issue before sending a patch.
+
+
+## Copyrights and License
+
+DictZip library for Java and command line utility.
+
+Copyright (C) 2001-2004 Ho Ngoc Duc
+
+Copyright (C) 2016-2021 Hiroshi Miura
+
+Some part of this program are come from a part of jdictd 1.5 on java.
+
+DictZip command line utility is distributed under the terms of GNU General
+Public License Version 2 or (at your option) any later version.
+
+DictZip library is distributed under the terms of the GNU General Public License
+Version 2 or (at your option) any later version with the following clarification
+and special exception as same as GNU classpath.
+
+Linking this library statically or dynamically with other modules is making
+a combined work based on this library. Thus, the terms and conditions of
+the GNU General Public License cover the whole combination.
+
+As a special exception, the copyright holders of this library give you permission
+to link this library with independent modules to produce an executable, regardless
+of the license terms of these independent modules, and to copy and distribute
+the resulting executable under terms of your choice, provided that you also meet,
+for each linked independent module, the terms and conditions of the license of
+that module. An independent module is a module which is not derived from or based on
+this library. If you modify this library, you may extend this exception to
+your version of the library, but you are not obligated to do so. If you do not wish
+to do so, delete this exception statement from your version.
 
-Dictributed by GPL-2 and later.
+As such, it can be used to run, create and distribute a large class of applications
+and applets. When this library is used unmodified as the core class library
+for a virtual machine, compiler for the java languge, or for a program written
+in the java programming language it does not affect the licensing for distributing
+those programs directly.