{"id":15471699,"url":"https://github.com/dkhamsing/readme-correct","last_synced_at":"2025-04-10T11:07:56.566Z","repository":{"id":76013535,"uuid":"52122249","full_name":"dkhamsing/readme-correct","owner":"dkhamsing","description":":grin: Fix GitHub typos with ease","archived":false,"fork":false,"pushed_at":"2017-05-29T13:38:46.000Z","size":9,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"stable","last_synced_at":"2024-10-19T01:15:51.989Z","etag":null,"topics":["correct","github","readme","typo"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":false,"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/dkhamsing.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-19T23:03:48.000Z","updated_at":"2024-05-25T11:36:26.000Z","dependencies_parsed_at":"2023-02-26T03:30:09.755Z","dependency_job_id":null,"html_url":"https://github.com/dkhamsing/readme-correct","commit_stats":{"total_commits":5,"total_committers":2,"mean_commits":2.5,"dds":0.4,"last_synced_commit":"e537a5dc3562dcfe1f19a467018eb657220e2154"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dkhamsing%2Freadme-correct","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dkhamsing%2Freadme-correct/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dkhamsing%2Freadme-correct/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dkhamsing%2Freadme-correct/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dkhamsing","download_url":"https://codeload.github.com/dkhamsing/readme-correct/tar.gz/refs/heads/stable","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208548,"owners_count":21065202,"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","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":["correct","github","readme","typo"],"created_at":"2024-10-02T02:21:23.531Z","updated_at":"2025-04-10T11:07:56.561Z","avatar_url":"https://github.com/dkhamsing.png","language":"Ruby","readme":"# readme-correct\n\nThe README correcting 🤖\n\n`readme-correct` can open a pull request to correct a typo found in a GitHub README. The code is adapted from https://github.com/dkhamsing/cocoapods-readme :sparkles:\n\n[![Build Status](https://travis-ci.org/dkhamsing/readme-correct.svg)](https://travis-ci.org/dkhamsing/readme-correct)\n\n## Installation\n\n```shell\n$ git clone https://github.com/dkhamsing/readme-correct.git\n$ cd readme-correct/\n$ rake install\n```\n\n## Usage\n\nCreate a [`correct.yml` file](bin/correct.example.yml)\n\n```yml\ncorrect: Mississippi\nincorrect:\n  - Missisipi\n  - Missisippi\n  - Mississipi\npull_commit_message: Correct the spelling of Mississippi in README\npull_request_title: Correct the spelling of Mississippi in README\npull_request_description: |\n  This pull request corrects the spelling of **Mississippi** 🤓\n  https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/M\n\n  Created with [`readme-correct`](https://github.com/dkhamsing/readme-correct).\n```\n\nRun `readme-correct`, it takes a GitHub repository as an argument.\n\n```\n$ readme-correct user/awesome-repo-with-typos\n```\n\n```\n$ readme-correct dkarchive/Mississipi\n```\n\n:tada:\n\n### Batch\n\nYou can even correct in batches with `batch-correct`, the input is a file with repos (one repo per line).\n\n```\n$ batch-correct list.txt\n```\n\n## Examples\n\n- https://github.com/rnpm/rnpm/pull/94\n- https://github.com/square/SocketRocket/pull/334\n- https://github.com/foursquare/FSQCellManifest/pull/2\n\n## Contact\n\n- [github.com/dkhamsing](https://github.com/dkhamsing)\n- [twitter.com/dkhamsing](https://twitter.com/dkhamsing)\n\n## License\n\nThis project is available under the MIT license. See the [LICENSE](LICENSE) file for more info.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdkhamsing%2Freadme-correct","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdkhamsing%2Freadme-correct","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdkhamsing%2Freadme-correct/lists"}