diff --git a/README.md b/README.md index ea513a8..66d46de 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # eslint-config -[![Build Status](https://img.shields.io/github/actions/workflow/status/kensho-technologies/eslint-config/ci.yml?branch=main)](https://github.com/kensho-technologies/eslint-config/actions) -[![npm](https://img.shields.io/npm/v/@kensho-technologies/eslint-config.svg)](https://npm.im/@kensho-technologies/eslint-config) +Standard ESLint config shared across Kensho projects. ## Install @@ -11,12 +10,12 @@ $ npm i -D eslint typescript @kensho-technologies/eslint-config ## Usage -Add an [**ESLint config**](http://eslint.org/docs/user-guide/configuring) that extends the config to a project, e.g.: +Add an [**ESLint configuration file**](https://eslint.org/docs/latest/use/configure/configuration-files) that includes the Kensho config: -```json -{ - "extends": "@kensho-technologies/eslint-config" -} +```js +import configs from '@kensho-technologies/eslint-config' + +export default [...configs] ``` Add scripts in **package.json** to [run the linter](http://eslint.org/docs/user-guide/command-line-interface), e.g.: diff --git a/package.json b/package.json index 07e5ea6..83f7b25 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@kensho-technologies/eslint-config", "version": "28.0.0", "type": "module", - "description": "Standard Kensho config to lint JS files.", + "description": "Standard ESLint config shared across Kensho projects.", "publishConfig": { "access": "public" },