Skip to content

Commit 70b4852

Browse files
author
Kathy Czeck
committed
first draft README changes - old contents still there
1 parent 35faf9f commit 70b4852

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
1-
[![Build Status](https://travis-ci.org/rosette-api/java.svg?branch=master)](https://travis-ci.org/rosette-api/java)
1+
[![Build Status](https://travis-ci.org/rosette-api/java.svg?branch=master)](https://travis-c## Rosette API Access
2+
- Rosette Cloud [Sign Up](https://developer.rosette.com/signup)
3+
- Rosette Enterprise [Evaluation](https://www.rosette.com/product-eval/)
4+
5+
i.org/rosette-api/java)
26
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.basistech.rosette/rosette-api-java-binding/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.basistech.rosette/rosette-api-java-binding)
37

48
# Java client binding for Rosette API #
59

6-
## Installation ##
10+
## Rosette API
11+
The Rosette Text Analytics Platform uses natural language processing, statistical modeling, and machine learning to
12+
analyze unstructured and semi-structured text across 364 language-encoding-script combinations, revealing valuable
13+
information and actionable data. Rosette provides endpoints for extracting entities and relationships, translating and
14+
comparing the similarity of names, categorizing and adding linguistic tags to text and more.
15+
16+
## Rosette API Access
17+
- Rosette Cloud [Sign Up](https://developer.rosette.com/signup)
18+
- Rosette Enterprise [Evaluation](https://www.rosette.com/product-eval/)
19+
20+
## Quick Start
21+
22+
### Installation ##
723
If you use Maven, include this dependency in your `pom.xml`:
824

925
```xml
@@ -26,6 +42,23 @@ compatibility with your installation.
2642
The source code on the master branch is the current state of development; it is not recommended for general use.
2743
If you prefer to build from source, please use an appropriate release tag.
2844

45+
#### Examples
46+
View small example programs for each Rosette endpoint
47+
in the [examples](https://github.com/rosette-api/java/tree/develop/examples) directory.
48+
49+
#### Documentation & Support
50+
- [Binding API](https://rosette-api.github.io/java/)
51+
- [Rosette Platform API](https://developer.rosette.com/features-and-functions)
52+
- [Binding Release Notes](https://github.com/rosette-api/java/wiki/Release-Notes)
53+
- [Rosette Platform Release Notes](https://support.rosette.com/hc/en-us/articles/360018354971-Release-Notes)
54+
- [Binding/Rosette Platform Compatibility](https://developer.rosette.com/features-and-functions?java#)
55+
- [Support](https://support.rosette.com)
56+
- [Binding License: Apache 2.0](https://github.com/rosette-api/java/blob/develop/LICENSE.txt)
57+
58+
## Binding Developer Information
59+
If you are modifying the binding code, please refer to the [developer README](https://github.com/rosette-api/java/tree/develop/DEVELOPER.md) file.
60+
61+
2962
## Basic Usage ##
3063
To check out more examples, see [examples](examples/src/main/java/com/basistech/rosette/examples)
3164

0 commit comments

Comments
 (0)