opennlp git commit: OPENNLP-1059: Update READM1E.md, this closes apache/opennlp#198

[sm...@apache.org]

Repository: opennlp
Updated Branches:
  refs/heads/master 108fa9a93 -> 068b1f3ce


OPENNLP-1059: Update READM1E.md, this closes apache/opennlp#198


Project: http://git-wip-us.apache.org/repos/asf/opennlp/repo
Commit: http://git-wip-us.apache.org/repos/asf/opennlp/commit/068b1f3c
Tree: http://git-wip-us.apache.org/repos/asf/opennlp/tree/068b1f3c
Diff: http://git-wip-us.apache.org/repos/asf/opennlp/diff/068b1f3c

Branch: refs/heads/master
Commit: 068b1f3ce5b46c32df08e3558b923e4d9ba362b0
Parents: 108fa9a
Author: beylerian <>
Authored: Mon May 15 14:10:47 2017 -0400
Committer: smarthi <sm...@apache.org>
Committed: Mon May 15 14:12:50 2017 -0400

----------------------------------------------------------------------
 README.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 66 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/opennlp/blob/068b1f3c/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 4b27762..824afe0 100644
--- a/README.md
+++ b/README.md
@@ -26,29 +26,54 @@ Welcome to Apache OpenNLP!
 [![Twitter Follow](https://img.shields.io/twitter/follow/ApacheOpennlp.svg?style=social)](https://twitter.com/ApacheOpenNLP)
 
 The Apache OpenNLP library is a machine learning based toolkit for the processing of natural language text.
-It supports the most common NLP tasks, such as tokenization, sentence segmentation,
-part-of-speech tagging, named entity extraction, chunking, parsing, and coreference resolution.
+
+This toolkit is written completly in Java and provides support for common NLP tasks, such as tokenization, sentence segmentation, part-of-speech tagging, named entity extraction, chunking, parsing, coreference resolution and more!
+
 These tasks are usually required to build more advanced text processing services.
-OpenNLP also includes maximum entropy and perceptron based machine learning.
-      
-The goal of the OpenNLP project is to create a mature toolkit for the above mentioned tasks.
+
+The goal of the OpenNLP project is to be a mature toolkit for the abovementioned tasks.
+
 An additional goal is to provide a large number of pre-built models for a variety of languages, as
 well as the annotated text resources that those models are derived from.
 
-For additional information about OpenNLP, visit the [OpenNLP Home Page](http://opennlp.apache.org/)
+Currently, OpenNLP also includes common classifiers such as Maximum Entropy, Perceptron and Naive Bayes.
+
+OpenNLP can be used both programmatically through its Java API or from a terminal through its CLI.
+
+## Useful Links
+       
+For additional information, visit the [OpenNLP Home Page](http://opennlp.apache.org/)
+
+You can use OpenNLP with any language, demo models are provided [here](http://opennlp.sourceforge.net/models-1.5/).
+
+The models are fully compatible with the latest release, they can be used for testing or getting started. 
+
+Please train your own models for all other use cases.
+
+Documentation, including JavaDocs, code usage and command-line interface examples are available [here](http://opennlp.apache.org/docs/)
+
+You can also follow our [mailing lists](http://opennlp.apache.org/mailing-lists.html) for news and updates.
+
+## Overview
+
+Currently the library has different packages:
+
+`opennlp-tools` : The core toolkit.
+
+`opennlp-uima` : A set of [Apache UIMA](https://uima.apache.org) annotators.
+
+`opennlp-brat-annotator` : A set of annotators for [BRAT](http://brat.nlplab.org/)
 
-Documentation for OpenNLP, including JavaDocs, code usage and command line interface are available [here](http://opennlp.apache.org/documentation.html)
+`opennlp-morfologik-addon` : An addon for Morfologik
 
-#### Using OpenNLP as a Library
+`opennlp-sandbox`: Other projects in progress are found in the [sandbox](https://github.com/apache/opennlp-sandbox)
 
-Running any application that uses OpenNLP will require installing a binary or source version and setting the environment.
-To compile from source:
 
-* `mvn -DskipTests clean install`
-* To run tests do `mvn test`
+## Getting Started
 
-To use maven, add the appropriate setting to your pom.xml or build.sbt following the template below.
+You can import the core toolkit directly from Maven, SBT or Gradle:
 
+#### Maven
 ```
 <dependency>
     <groupId>org.apache.opennlp</groupId>
@@ -57,3 +82,31 @@ To use maven, add the appropriate setting to your pom.xml or build.sbt following
 </dependency>
 ```
 
+#### SBT
+```
+libraryDependencies += "org.apache.opennlp" % "opennlp-tools" % "${opennlp.version}"
+```
+
+#### Gradle
+```
+compile group: "org.apache.opennlp", name: "opennlp-tools", version: "$opennlp.version"
+```
+
+
+For more details please check our [documentation](http://opennlp.apache.org/docs/)
+
+## Building OpenNLP
+
+At least JDK 8 and Maven 3.3.9 are required to build the library.
+
+After cloning the repository go into the destination directory and run:
+
+```
+mvn install
+```
+
+## Contributing
+
+The Apache OpenNLP project is developed by volunteers and is always looking for new contributors to work on all parts of the project. Every contribution is welcome and needed to make it better. A contribution can be anything from a small documentation typo fix to a new component.
+
+If you would like to get involved please follow the instructions [here](https://github.com/apache/opennlp/blob/master/.github/CONTRIBUTING.md)
\ No newline at end of file