tmknom/prh repository overview

⁠prh

A proofreading helper.

This is prh⁠ wrapper.

⁠Requirements

• Docker⁠

⁠Usage

⁠Proofread markdown

docker run --rm -v "$PWD:/work" tmknom/prh --rules prh.yml **/*.md

⁠Help

docker run --rm -v "$PWD:/work" tmknom/prh

⁠Makefile targets

build                          Build docker image
format                         Format code
help                           Show help
install                        Install requirements
lint                           Lint code

⁠Development

⁠Installation

git clone [email protected]:tmknom/prh.git
cd prh
make install

⁠Deployment

Automatically deployed by "DockerHub Automated Build⁠" after merge.

⁠Deployment Pipeline

1. GitHub - Version Control System
   • https://github.com/tmknom/prh⁠
2. CircleCI - Continuous Integration
   • https://circleci.com/gh/tmknom/prh⁠
3. Docker Hub - Docker Registry
   • https://hub.docker.com/r/tmknom/prh⁠
4. MicroBadger - Docker Inspection
   • https://microbadger.com/images/tmknom/prh⁠

⁠License

Apache 2 Licensed. See LICENSE for full details.