Table of Contents
English prose and spellchecker build on nodehun & write-good
Built with ❤︎ by tiaanduplessis and contributors
Table of Contents
Install
$ npm install proofread-core# OR $ yarn add proofread-core
Usage
const proofRead = // { 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
options.
Contributing
Contributions are welcome!
- Fork it.
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Or open up a issue.
License
Licensed under the MIT License.