readme-correct

The README correcting 🤖

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 ✨

Installation

$ git clone https://github.com/dkhamsing/readme-correct.git
$ cd readme-correct/
$ rake install

Usage

Create a correct.yml file

correct: Mississippi
incorrect:
  - Missisipi
  - Missisippi
  - Mississipi
pull_commit_message: Correct the spelling of Mississippi in README
pull_request_title: Correct the spelling of Mississippi in README
pull_request_description: |
  This pull request corrects the spelling of **Mississippi** 🤓
  https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/M

  Created with [`readme-correct`](https://github.com/dkhamsing/readme-correct).

Run readme-correct, it takes a GitHub repository as an argument.

$ readme-correct user/awesome-repo-with-typos

$ readme-correct dkarchive/Mississipi

🎉

Batch

You can even correct in batches with batch-correct, the input is a file with repos (one repo per line).

$ batch-correct list.txt

Examples

• rnpm/rnpm#94
• facebookincubator/SocketRocket#334
• foursquare/FSQCellManifest#2

Contact

• github.com/dkhamsing
• twitter.com/dkhamsing

License

This project is available under the MIT license. See the LICENSE file for more info.