Comparing version
{ | ||
"name": "retext", | ||
"version": "6.0.1", | ||
"version": "6.0.2", | ||
"description": "Natural language processor powered by plugins", | ||
@@ -5,0 +5,0 @@ "license": "MIT", |
@@ -1,7 +0,15 @@ | ||
# retext [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size] [![Chat][chat-badge]][chat] | ||
# retext | ||
[![Build][build-badge]][build] | ||
[![Coverage][coverage-badge]][coverage] | ||
[![Downloads][downloads-badge]][downloads] | ||
[![Size][size-badge]][size] | ||
[![Sponsors][sponsors-badge]][collective] | ||
[![Backers][backers-badge]][collective] | ||
[![Chat][chat-badge]][chat] | ||
[**retext**][retext] is a natural language processor powered by [plugins][] | ||
part of the [unified][] [collective][]. | ||
* API by [`unified`][unified] | ||
* API by [**unified**][unified] | ||
* Parses natural language to the tree with [`retext-latin`][latin] | ||
@@ -14,7 +22,2 @@ * [**nlcst**][nlcst] syntax tree | ||
* * * | ||
**Announcing the unified collective! 🎉 | ||
[Read more about it on Medium »][announcement]** | ||
## Sponsors | ||
@@ -52,11 +55,13 @@ | ||
## Installation | ||
[**Read more about the unified collective on Medium »**][announcement] | ||
## Install | ||
[npm][]: | ||
```bash | ||
```sh | ||
npm install retext | ||
``` | ||
## Usage | ||
## Use | ||
@@ -69,8 +74,6 @@ ```js | ||
var doc = 'He’s set on beating your butt for sheriff! :cop:' | ||
retext() | ||
.use(profanities) | ||
.use(emoji, {convert: 'encode'}) | ||
.process(doc, function(err, file) { | ||
.process('He’s set on beating your butt for sheriff! :cop:', function(err, file) { | ||
console.log(String(file)) | ||
@@ -90,2 +93,16 @@ console.error(report(err || file)) | ||
## Contribute | ||
See [`contributing.md`][contributing] in [`retextjs/.github`][health] for ways | ||
to get started. | ||
See [`support.md`][support] for ways to get help. | ||
Ideas for new plugins and tools can be posted in [`retextjs/ideas`][ideas]. | ||
A curated list of awesome retext resources can be found in [**awesome | ||
retext**][awesome]. | ||
This project has a [Code of Conduct][coc]. | ||
By interacting with this repository, organisation, or community you agree to | ||
abide by its terms. | ||
## License | ||
@@ -97,3 +114,3 @@ | ||
[build-badge]: https://img.shields.io/travis/retextjs/retext/master.svg | ||
[build-badge]: https://img.shields.io/travis/retextjs/retext.svg | ||
@@ -114,2 +131,8 @@ [build]: https://travis-ci.org/retextjs/retext | ||
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg | ||
[backers-badge]: https://opencollective.com/unified/backers/badge.svg | ||
[collective]: https://opencollective.com/unified | ||
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg | ||
@@ -119,2 +142,14 @@ | ||
[health]: https://github.com/retextjs/.github | ||
[contributing]: https://github.com/retextjs/.github/blob/master/contributing.md | ||
[support]: https://github.com/retextjs/.github/blob/master/support.md | ||
[coc]: https://github.com/retextjs/.github/blob/master/code-of-conduct.md | ||
[ideas]: https://github.com/retextjs/ideas | ||
[awesome]: https://github.com/retextjs/awesome-retext | ||
[license]: https://github.com/retextjs/Lobby/blob/master/license | ||
@@ -126,18 +161,16 @@ | ||
[retext]: https://github.com/retextjs/retext | ||
[unified]: https://github.com/unifiedjs/unified | ||
[nlcst]: https://github.com/syntax-tree/nlcst | ||
[announcement]: https://medium.com/unifiedjs/collectively-evolving-through-crowdsourcing-22c359ea95cc | ||
[latin]: https://github.com/retextjs/retext/blob/master/packages/retext-latin | ||
[latin]: https://github.com/retextjs/retext/tree/master/packages/retext-latin | ||
[stringify]: https://github.com/retextjs/retext/blob/master/packages/retext-stringify | ||
[stringify]: https://github.com/retextjs/retext/tree/master/packages/retext-stringify | ||
[plugins]: https://github.com/retextjs/retext/blob/master/doc/plugins.md | ||
[plugins]: https://github.com/retextjs/retext/tree/master/doc/plugins.md | ||
[unified-usage]: https://github.com/unifiedjs/unified#usage | ||
[retext]: https://github.com/retextjs/retext | ||
[collective]: https://opencollective.com/unified | ||
[nlcst]: https://github.com/syntax-tree/nlcst | ||
[announcement]: https://medium.com/unifiedjs/collectively-evolving-through-crowdsourcing-22c359ea95cc | ||
[unified-usage]: https://github.com/unifiedjs/unified#usage |
5978
20.38%169
24.26%