https://github.com/tiaanduplessis/proofread-core

English prose and spellchecker build on nodehun & write-good
https://github.com/tiaanduplessis/proofread-core

nodehun proofread write-good

Last synced: 10 months ago
JSON representation

English prose and spellchecker build on nodehun & write-good

• Host: GitHub
• URL: https://github.com/tiaanduplessis/proofread-core
• Owner: tiaanduplessis
• License: mit
• Created: 2017-10-25T10:05:15.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-11-21T13:56:47.000Z (over 6 years ago)
• Last Synced: 2025-07-24T22:47:03.295Z (10 months ago)
• Topics: nodehun, proofread, write-good
• Language: JavaScript
• Size: 539 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

proofread-core



  English prose and spellchecker build on nodehun & write-good








  

    

  

  

  

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  








  

    

  

  

    

  

  

    

  








  Built with ❤︎ by tiaanduplessis and contributors



Table of Contents


  Table of Contents

  
Install

  
Usage

  
Contribute

  
License


## Install

[![Greenkeeper badge](https://badges.greenkeeper.io/tiaanduplessis/proofread-core.svg)](https://greenkeeper.io/)

```sh

$ npm install proofread-core

# OR

$ yarn add proofread-core

```

## Usage

```js

const proofRead = require('proofread-core')

proofRead(`

    So the cat was stolen.

    Cuz for reasons.

`)

  .then(console.log)

  .catch(console.error)

//   { suggestions:

//    [ { index: 0, offset: 2, reason: '"So" adds no meaning' },

//      { index: 11,

//        offset: 10,

//        reason: '"was stolen" may be passive voice' } ],

//   typos: [ { word: 'Cuz', suggestions: [Array], positions: [Array] } ] }

```

Optionally specify the dictionary (see [dictionaries](dictionaries) directory for available english dictionaries) to use and any of the available [`write-good`](https://github.com/btford/write-good#checks) options.

```js

proofRead(`

    So the cat was stolen.

    Cuz for reasons.

`, {

  dictionary: 'us',

  passive: false

})

  .then(console.log)

  .catch(console.error)

```

## Contributing

Contributions are welcome!

1. Fork it.

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

Or open up [a issue](https://github.com/tiaanduplessis/proofread-core/issues).

## License

Licensed under the MIT License.