proofread-core

Table of Contents

Install

``sh
$ npm install proofread-core


OR

`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 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.

License

Licensed under the MIT License.