tmknom/write-good repository overview

⁠write-good

Naive linter for English prose based on Docker.

This is write-good⁠ wrapper.

⁠Requirements

• Docker⁠

⁠Usage

docker run --rm -v "$PWD:/work" tmknom/write-good **/*.md

⁠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/write-good.git
cd write-good
make install

⁠Deployment

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

⁠Deployment Pipeline

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

⁠License

Apache 2 Licensed. See LICENSE for full details.