diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml index 43389076f..95665b4ec 100644 --- a/.github/workflows/build-and-test.yml +++ b/.github/workflows/build-and-test.yml @@ -34,7 +34,7 @@ jobs: run: | npm ci npm i --no-save eslint ts-node typescript - npm run plugins:ci + # npm run plugins:ci - name: static checks run: | @@ -43,7 +43,7 @@ jobs: - name: build run: | npm run build - npm run plugins:build + # npm run plugins:build - name: test run: | diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b3bbd6ba3..66527c73b 100755 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -36,7 +36,7 @@ jobs: run: | npm ci npm i --no-save eslint ts-node typescript - npm run plugins:ci + # npm run plugins:ci - name: static checks run: | @@ -45,7 +45,7 @@ jobs: - name: build run: | npm run build - npm run plugins:build + # npm run plugins:build - name: test run: | diff --git a/README.md b/README.md index 5c734f299..ef40a1638 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ it is small, quick, - and usually good-enough. + and often good-enough. @@ -55,18 +55,17 @@ ### .match(): -compromise makes it simple to interpret and match text: +interpret and match text: ```js let doc = nlp(entireNovel) - -doc.if('the #Adjective of times').text() -// "it was the blurst of times??" +doc.match('the #Adjective of times').text() +// "the blurst of times?" ``` ```js -if (doc.has('simon says #Verb')) { - return true +if (doc.has('simon says #Verb') === false) { + return null } ``` @@ -115,7 +114,7 @@ doc.text() ### .numbers(): -interpret plaintext numbers +interpret plain-text numbers ```js nlp.extend(require('compromise-numbers')) @@ -135,7 +134,7 @@ doc.text() ### .topics(): -grab subjects in a text: +grab the big subjects: ```js let doc = nlp(buddyHolly) @@ -164,7 +163,7 @@ doc.topics().json() ### .contractions(): -work with contracted and implicit words: +handle implicit words: ```js let doc = nlp("we're not gonna take it, no we ain't gonna take it.") @@ -202,7 +201,7 @@ Use it on the client-side: ``` -or as an es-module: +as an es-module: ```typescript import nlp from 'compromise' @@ -232,7 +231,7 @@ it's pretty fast. It can run on keypress: -it works mainly by conjugating many forms of a basic word list. +it works mainly by conjugating all forms of a basic word list. The final lexicon is ~14,000 words: @@ -240,7 +239,7 @@ The final lexicon is -you can read more about how it works, [here](https://observablehq.com/@spencermountain/compromise-internals). +you can read more about how it works, [here](https://observablehq.com/@spencermountain/compromise-internals). it's weird. @@ -250,7 +249,7 @@ you can read more about how it works, [here](https://observablehq.com/@spencermo ### .extend(): -set a custom interpretation of your own words: +decide how words get interpreted: ```js let myWords = { @@ -260,7 +259,7 @@ let myWords = { let doc = nlp(muppetText, myWords) ``` -or make more changes with a [compromise-plugin](https://observablehq.com/@spencermountain/compromise-plugins). +or make heavier changes with a [compromise-plugin](https://observablehq.com/@spencermountain/compromise-plugins). ```js const nlp = require('compromise') @@ -309,11 +308,11 @@ nlp.extend((Doc, world) => { ### Docs: -##### Warm introduction: +##### gentle introduction: -- **[#1 Input → output](https://docs.compromise.cool/tutorial-1)** -- **[#2 Match & transform](https://docs.compromise.cool/compromise-tutorial-2)** -- **[#3 Making a chat-bot](https://docs.compromise.cool/compromise-making-a-bot)** +- **[#1) Input → output](https://docs.compromise.cool/tutorial-1)** +- **[#2) Match & transform](https://docs.compromise.cool/compromise-tutorial-2)** +- **[#3) Making a chat-bot](https://docs.compromise.cool/compromise-making-a-bot)**