Add documentation

Author: j2gl

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+To contribute do the following:
+1. Check existing open issues.
+2. If not found, file an issue with any relevant information (versions, steps to reproduce, stacktrace, screenshots, etc).
+3. Fork repository.
+4. Create a branch on your fork and add the issue # to he name.  Like feature/issue-23 or bug/issue-65.
+5. Try to match the style code.
+6. Create a pull request to develop branch.
+
+Feel free to send any question.

README.md

@@ -1,12 +1,41 @@
-A fork of [java-diff-utils](https://code.google.com/p/java-diff-utils/)
+# java-diff-utils
 
-# Changelog
+The java-diff-utils library is for computing diffs, applying patches, generation side-by-side view in Java.
 
-## 2.1.0
+It is an OpenSource library for performing the comparison operations between texts: computing diffs, applying patches, generating unified diffs or parsing them, generating diff output for easy future displaying (like side-by-side view) and so on.
 
-- Removes the dependency on Guava
+Main reason to build this library was the lack of easy-to-use libraries with all the usual stuff you need while working with diff files. Originally it was inspired by JRCS library and it's nice design of diff module.
 
-## 2.0.0
+**Original code and docs were forked from:** [java-diff-utils](https://code.google.com/p/java-diff-utils/)
+
+## Main Features
+
+* computing the difference between two texts.
+* capable to hand more than plain ascci. Arrays or List of any type that implements hashCode() and equals() correctly can be subject to differencing using this library
+* patch and unpatch the text with the given patch
+* parsing the unified diff format
+* producing human-readable differences
+
+## Algorithms
+
+This library implements Myer's diff algorithm. But it can easily replaced by any other which is better for handing your texts.
+
+# Tutorial
+
+* In Spanish: [Comparar Ficheros java-diff-utils](https://www.adictosaltrabajo.com/tutoriales/comparar-ficheros-java-diff-utils/)
+
+## Changelog
+
+### 2.1.1
+
+- Bugfix: Fix issue showing inline diffs.
+- Added some unit tests.
+
+### 2.1.0
+
+- Removes the dependency on Guavatime
+
+### 2.0.0
 
 - Change groupId and artifactId to prevent conflict with origin library: now 'com.github.java-diff-utils:java-diff-utils' instead of 'jp.skypencil.java-diff-utils:diffutils'
 - Adds the ability to differentiate the inserted and deleted tags and class-names in inline-diff
@@ -18,18 +47,17 @@ A fork of [java-diff-utils](https://code.google.com/p/java-diff-utils/)
 - fix imbrication tag bug in lineDiff (when inline is on a multi-line chunk)
 - Adds tha ability to skip data
 
-## 1.5.0
+### 1.5.0
 
 - make Equalizer configurable. ([pull #1](https://github.com/eller86/java-diff-utils/pull/1))
 
-## 1.4.1
+### 1.4.1
 
 - bugfix: parse method should be public
 
-## 1.4.0
+### 1.4.0
 
 - switch from JDK5 to JDK7
 - add Guava to dependency
 - let user uses other string to represent line which does not exist
 - implement event based parser like SAX (in difflib.event package)
-

build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'java'
 apply plugin: 'maven'
 
 group = 'com.github.java-diff-utils'
-version = '2.1.0-SNAPSHOT'
+version = '2.1.1-SNAPSHOT'
 
 description = """java-diff-utils"""