diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md new file mode 100644 index 0000000000..c0034d36c6 --- /dev/null +++ b/packages/eslint-config/README.md @@ -0,0 +1,25 @@ + + +# [Blueprint](http://blueprintjs.com/) [ESLint](https://eslint.org/) Configuration + +Blueprint is a React UI toolkit for the web. + +This package contains the [ESLint](https://eslint.org/) configuration for Blueprint. It enables lint rules which enforce code style conventions and enables the `@blueprintjs/eslint-plugin-blueprint` plugin. + +## Installation + +``` +yarn add @blueprintjs/eslint-config +``` + +## Usage + +Enable this configuration in your ESLint configuration file (e.g. `.eslintrc.json`): + +```json +{ + "extends": [ + "@blueprintjs/eslint-config" + ] +} +```