Skip to content

Commit 8d38bf0

Browse files
docs: update README and add tags too package.json
1 parent c8101aa commit 8d38bf0

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# wink-nlp
1+
# winkNLP
22

33
✨ Natural Language Processing
44

@@ -8,6 +8,7 @@
88

99
winkNLP is a JavaScript library for Natural Language Processing (NLP). Designed specifically to make development of NLP solutions **easier** and **faster**, winkNLP is optimized for the right balance of performance and accuracy. The package can handle large amount of raw text at speeds over **500,000 tokens/second**. And with a test coverage of ~100%, winkNLP is a tool for building production grade systems with confidence.
1010

11+
#### Features
1112
It packs a rich feature set into a small foot print codebase of [under 1500 lines](https://coveralls.io/github/winkjs/wink-nlp?branch=master):
1213

1314
1. Lossless tokenizer
@@ -26,14 +27,14 @@ Use [npm](https://www.npmjs.com/package/wink-nlp) install:
2627

2728
npm install wink-nlp --save
2829

29-
You will also need the English lite model, to install that use:
30+
You will also need the English lite model:
3031

3132
npm install https://github.com/winkjs/wink-eng-lite-model/releases/download/0.2.0/wink-eng-lite-model-0.2.0.tgz --save
3233

3334
### Documentation
3435
- [Concepts](https://winkjs.org/wink-nlp/getting-started.html) — everything you need to know to get started.
35-
- [API Reference](https://winkjs.org/wink-nlp/read-doc.html)details of every winkNLP's API.
36-
- [Change log](https://github.com/winkjs/wink-nlp/blob/master/CHANGELOG.md) — version history along with details of breaking changes.
36+
- [API Reference](https://winkjs.org/wink-nlp/read-doc.html)explains usage of APIs with examples.
37+
- [Change log](https://github.com/winkjs/wink-nlp/blob/master/CHANGELOG.md) — version history along with the details of breaking changes, if any.
3738

3839
### Need Help?
3940
If you spot a bug and the same has not yet been reported, raise a new [issue](https://github.com/winkjs/wink-nlp/issues) or consider fixing it and sending a pull request.

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@
1212
"POS Tagging",
1313
"NER",
1414
"named entity extraction",
15+
"custome entity detection",
1516
"word vectors",
1617
"visualization",
18+
"pattern matching",
19+
"winkNLP",
1720
"wink"
1821
],
1922
"main": "src/wink-nlp.js",

0 commit comments

Comments
 (0)