Skip to content

Commit e1256e1

Browse files
committed
SUPPO-1256: Node engine 8.0 and up. Drop iojs. Add more keywords. Logo. Another badge. Formatting.
1 parent 4795bf2 commit e1256e1

File tree

2 files changed

+54
-47
lines changed

2 files changed

+54
-47
lines changed

README.md

Lines changed: 37 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,37 @@
1-
[![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)
2-
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?javascript#)
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.
1+
<a href="https://www.rosette.com"><img src="https://s3.amazonaws.com/styleguide.basistech.com/logos/rosette-logo.png" width="181" height="47" /></a>
2+
3+
---
4+
5+
[![Build Status](https://travis-ci.org/rosette-api/nodejs.svg?branch=develop)](https://travis-ci.org/rosette-api/nodejs)
6+
[![npm version](https://badge.fury.io/js/rosette-api.svg)](https://badge.fury.io/js/rosette-api)
7+
![node engine](https://img.shields.io/node/v/rosette-api.svg)
8+
9+
## Rosette API
10+
The Rosette Text Analytics Platform uses natural language processing, statistical modeling, and machine learning to
11+
analyze unstructured and semi-structured text across 364 language-encoding-script combinations, revealing valuable
12+
information and actionable data. Rosette provides endpoints for extracting entities and relationships, translating and
13+
comparing the similarity of names, categorizing and adding linguistic tags to text and more.
14+
15+
## Rosette API Access
16+
- Rosette Cloud [Sign Up](https://developer.rosette.com/signup)
17+
- Rosette Enterprise [Evaluation](https://www.rosette.com/product-eval/)
18+
19+
## Quick Start
20+
21+
#### Installation
22+
`npm install rosette-api`
23+
24+
#### Examples
25+
View small example programs for each Rosette endpoint in the [examples](examples) directory.
26+
27+
#### Documentation & Support
28+
- [Binding API](https://rosette-api.github.io/nodejs/)
29+
- [Rosette Platform API](https://developer.rosette.com/features-and-functions)
30+
- [Binding Release Notes](https://github.com/rosette-api/nodejs/wiki/Release-Notes)
31+
- [Rosette Platform Release Notes](https://support.rosette.com/hc/en-us/articles/360018354971-Release-Notes)
32+
- [Binding/Rosette Platform Compatibility](https://developer.rosette.com/features-and-functions?javascript#)
33+
- [Support](https://support.rosette.com)
34+
- [Binding License: Apache 2.0](LICENSE.txt)
35+
36+
## Binding Developer Information
37+
If you are modifying the binding code, please refer to the [developer README](DEVELOPER.md) file.

package.json

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,31 @@
1212
"url": "git://github.com/rosette-api/nodejs.git"
1313
},
1414
"keywords": [
15-
"rosette",
16-
"basis",
15+
"categorization",
16+
"entity extraction",
17+
"language detection",
18+
"lemmatization",
19+
"morphology",
20+
"name deduplication",
21+
"name similarity",
22+
"name translation",
23+
"natural language processing",
1724
"nlp",
18-
"text analytics"
25+
"relationship extraction",
26+
"semantic similarity",
27+
"sentiment analysis",
28+
"syntactic dependencies",
29+
"text analytics",
30+
"tokenization",
31+
"transliteration"
1932
],
2033
"author": {
2134
"name": "Basis Technology Corp",
2235
"email": "[email protected]"
2336
},
2437
"license": "Apache-2.0",
2538
"engines": {
26-
"node": ">=0.12.0",
27-
"iojs": "*"
39+
"node": ">=8.0.0"
2840
},
2941
"bugs": {
3042
"url": "https://github.com/rosette-api/nodejs/issues"

0 commit comments

Comments
 (0)