diff --git a/README.md b/README.md index 845df52..5d99a2d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Code Reviewer -[![ci](https://github.com/Sokkuri/Code-Reviewer/workflows/CI/badge.svg)](https://github.com/Sokkuri/Code-Reviewer/commits/master) -Linter docker image +This action runs the in the project installed ESLint with the project specific config to check if the rules have been respected. ## How to use ### Github Action @@ -13,18 +12,3 @@ jobs: - uses: actions/checkout@vx.x.x - uses: sokkuri/code-reviewer@vx.x.x ``` - -### GitLab CI -To use this as a step in **GitLab CI**, you can use this image like in [this configuration](https://gitlab.com/sokkuri/CI/-/blob/master/.gitlab/ci/linter.gitlab-ci.yml). - -### Other -In other environments, you could use this command: `docker run --rm -e WORKSPACE=/lint -v /PATH_TO_FOLDER:/lint sokkuri/code-reviewer` - -## Build image locally -To build this image locally there is the `buildDockerImage.ps1` script in the `build` folder. - -## Used Linters -| Linter | -| ------------------------------------------------------------------------------------ | -| [Editorconfig Checker](https://github.com/editorconfig-checker/editorconfig-checker) | -| [Eslint](https://github.com/eslint/eslint) |