{"id":30060074,"url":"https://github.com/tiaanduplessis/proofread-core","last_synced_at":"2025-08-08T01:41:56.666Z","repository":{"id":49120912,"uuid":"108252673","full_name":"tiaanduplessis/proofread-core","owner":"tiaanduplessis","description":"English prose and spellchecker build on nodehun \u0026 write-good","archived":false,"fork":false,"pushed_at":"2019-11-21T13:56:47.000Z","size":552,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-24T22:47:03.295Z","etag":null,"topics":["nodehun","proofread","write-good"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tiaanduplessis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-25T10:05:15.000Z","updated_at":"2022-05-30T09:47:17.000Z","dependencies_parsed_at":"2022-09-05T13:21:44.407Z","dependency_job_id":null,"html_url":"https://github.com/tiaanduplessis/proofread-core","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/tiaanduplessis/proofread-core","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fproofread-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fproofread-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fproofread-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fproofread-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tiaanduplessis","download_url":"https://codeload.github.com/tiaanduplessis/proofread-core/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fproofread-core/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269352373,"owners_count":24402671,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-07T02:00:09.698Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodehun","proofread","write-good"],"created_at":"2025-08-08T01:41:41.947Z","updated_at":"2025-08-08T01:41:56.644Z","avatar_url":"https://github.com/tiaanduplessis.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003ch1 align=\"center\"\u003eproofread-core\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003cstrong\u003eEnglish prose and spellchecker build on nodehun \u0026amp; write-good\u003c/strong\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://npmjs.org/package/proofread-core\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/proofread-core.svg?style=flat-square\" alt=\"npm package version\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://npmjs.org/package/proofread-core\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/dm/proofread-core.svg?style=flat-square\" alt=\"npm downloads\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/feross/standard\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square\" alt=\"standard JS linter\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/prettier/prettier\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square\" alt=\"prettier code formatting\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://travis-ci.org/tiaanduplessis/proofread-core\"\u003e\n    \u003cimg src=\"https://img.shields.io/travis/tiaanduplessis/proofread-core.svg?style=flat-square\" alt=\"travis ci build status\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/tiaanduplessis/proofread-core/blob/master/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/l/proofread-core.svg?style=flat-square\" alt=\"project license\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"http://makeapullrequest.com\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\" alt=\"make a pull request\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/tiaanduplessis/proofread-core/watchers\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/watchers/tiaanduplessis/proofread-core.svg?style=social\" alt=\"Github Watch Badge\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/tiaanduplessis/proofread-core/stargazers\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/tiaanduplessis/proofread-core.svg?style=social\" alt=\"Github Star Badge\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://twitter.com/intent/tweet?text=Check%20out%20proofread-core!%20https://github.com/tiaanduplessis/proofread-core%20%F0%9F%91%8D\"\u003e\n    \u003cimg src=\"https://img.shields.io/twitter/url/https/github.com/tiaanduplessis/proofread-core.svg?style=social\" alt=\"Tweet\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n  Built with ❤︎ by \u003ca href=\"https://github.com/tiaanduplessis\"\u003etiaanduplessis\u003c/a\u003e and \u003ca href=\"https://github.com/tiaanduplessis/proofread-core/contributors\"\u003econtributors\u003c/a\u003e\n\u003c/div\u003e\n\n\u003ch2\u003eTable of Contents\u003c/h2\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003cli\u003e\u003ca href=\"#install\"\u003eInstall\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"#contribute\"\u003eContribute\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n\u003c/details\u003e\n\n## Install\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/tiaanduplessis/proofread-core.svg)](https://greenkeeper.io/)\n\n```sh\n$ npm install proofread-core\n# OR\n$ yarn add proofread-core\n```\n\n## Usage\n\n```js\nconst proofRead = require('proofread-core')\n\nproofRead(`\n    So the cat was stolen.\n    Cuz for reasons.\n`)\n  .then(console.log)\n  .catch(console.error)\n\n//   { suggestions:\n//    [ { index: 0, offset: 2, reason: '\"So\" adds no meaning' },\n//      { index: 11,\n//        offset: 10,\n//        reason: '\"was stolen\" may be passive voice' } ],\n//   typos: [ { word: 'Cuz', suggestions: [Array], positions: [Array] } ] }\n```\n\nOptionally 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.\n\n```js\nproofRead(`\n    So the cat was stolen.\n    Cuz for reasons.\n`, {\n  dictionary: 'us',\n  passive: false\n})\n  .then(console.log)\n  .catch(console.error)\n\n```\n\n## Contributing\n\nContributions are welcome!\n\n1. Fork it.\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\nOr open up [a issue](https://github.com/tiaanduplessis/proofread-core/issues).\n\n## License\n\nLicensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiaanduplessis%2Fproofread-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiaanduplessis%2Fproofread-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiaanduplessis%2Fproofread-core/lists"}