[jira] [Commented] (OPENNLP-1691) Add README to opennlp-addons

[ASF GitHub Bot (Jira)]

    [ 
https://issues.apache.org/jira/browse/OPENNLP-1691?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17915979#comment-17915979
 ] 

ASF GitHub Bot commented on OPENNLP-1691:
-----------------------------------------

mawiesne commented on code in PR #59:
URL: https://github.com/apache/opennlp-addons/pull/59#discussion_r1924986264


##########
README.md:
##########
@@ -0,0 +1,104 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+Welcome to Apache OpenNLP!
+===========
+
+[![Build 
Status](https://github.com/apache/opennlp-addons/workflows/Java%20CI/badge.svg)](https://github.com/apache/opennlp-addons/actions)
+[![Contributors](https://img.shields.io/github/contributors/apache/opennlp-addons)](https://github.com/apache/opennlp-addons/graphs/contributors)
+[![GitHub pull 
requests](https://img.shields.io/github/issues-pr-raw/apache/opennlp-addons.svg)](https://github.com/apache/opennlp-addons/pulls)
+[![Stack 
Overflow](https://img.shields.io/badge/stack%20overflow-opennlp-f1eefe.svg)](https://stackoverflow.com/questions/tagged/opennlp)
+
+The Apache OpenNLP library is a machine learning based toolkit for the 
processing of natural language text.
+
+These addons of the toolkit are written in Java and provide components for 
special NLP tasks, such as 
+geographic entity linking, Wordnet dictionary access and integration with 
Liblinear and Morfologik!
+
+The goal of the OpenNLP addons is to provide extra components, potentially in 
an experimental stage.
+
+OpenNLP addons code can be used both programmatically through its Java API, 
some components even from a terminal through its CLI.

Review Comment:
   thx, will fix





> Add README to opennlp-addons
> ----------------------------
>
>                 Key: OPENNLP-1691
>                 URL: https://issues.apache.org/jira/browse/OPENNLP-1691
>             Project: OpenNLP
>          Issue Type: Task
>          Components: Documentation
>            Reporter: Richard Zowalla
>            Assignee: Martin Wiesner
>            Priority: Minor
>             Fix For: 2.5.4
>
>
> As the title says



--
This message was sent by Atlassian Jira
(v8.20.10#820010)