diff --git a/README.md b/README.md index 57ddae4..f1f3c43 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -# eslint-config-zt \ No newline at end of file +# ZeroTurnaround's ESLint config + +## Installation +```shell +$ npm install --save-dev github:zeroturnaround/eslint-config-zt +``` + +## Usage +```yaml +// .eslintrc.yml +--- +extends: + - "zt" + +rules: + # Some overrides + no-fallthrough: 0 +``` \ No newline at end of file