Skip to content

Commit 2c9e3a3

Browse files
author
Kathy Czeck
committed
First draft new README file
1 parent 5292a27 commit 2c9e3a3

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,57 @@
11
[![Build Status](https://travis-ci.org/rosette-api/nodejs.svg?branch=develop)](https://travis-ci.org/rosette-api/nodejs) [![npm version](https://badge.fury.io/js/rosette-api.svg)](https://badge.fury.io/js/rosette-api)
22

3+
# Node.js client Binding for Rosette API #
4+
5+
## Rosette API
6+
The Rosette Text Analytics Platform uses natural language processing, statistical modeling, and machine learning to
7+
analyze unstructured and semi-structured text across 364 language-encoding-script combinations, revealing valuable
8+
information and actionable data. Rosette provides endpoints for extracting entities and relationships, translating and
9+
comparing the similarity of names, categorizing and adding linguistic tags to text and more.
10+
11+
## Rosette API Access
12+
- Rosette Cloud [Sign Up](https://developer.rosette.com/signup)
13+
- Rosette Enterprise [Evaluation](https://www.rosette.com/product-eval/)
14+
15+
## Quick Start ##
16+
17+
### Installation ###
18+
19+
`npm install rosette-api`
20+
21+
To check your installed version:
22+
23+
- `npm list rosette-api` for local installation
24+
- `npm list -g rosette-api` for global installation
25+
26+
https://www.npmjs.com/package/rosette-api
27+
28+
#### Examples
29+
View small example programs for each Rosette endpoint
30+
in the [examples](https://github.com/rosette-api/nodejs/tree/develop/examples) directory.
31+
32+
#### Documentation & Support
33+
- [Binding API](https://rosette-api.github.io/nodejs/)
34+
- [Rosette Platform API](https://developer.rosette.com/features-and-functions)
35+
- [Binding Release Notes](https://github.com/rosette-api/nodejs/wiki/Release-Notes)
36+
- [Rosette Platform Release Notes](https://support.rosette.com/hc/en-us/articles/360018354971-Release-Notes)
37+
- [Binding/Rosette Platform Compatibility](https://developer.rosette.com/features-and-functions?nodejs#)
38+
- [Support](https://support.rosette.com)
39+
- [Binding License: Apache 2.0](https://github.com/rosette-api/nodejs/blob/develop/LICENSE.txt)
40+
41+
## Binding Developer Information
42+
If you are modifying the binding code, please refer to the [developer README](https://github.com/rosette-api/nodejs/tree/develop/DEVELOPER.md) file.
43+
44+
45+
46+
47+
48+
49+
50+
51+
52+
53+
54+
355
# rosette-api
456

557
This is the Rosette API client binding for node.js.

0 commit comments

Comments
 (0)