Skip to content

Commit

Permalink
Update readme and package metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
billyjanitsch committed Nov 18, 2024
1 parent ba0847f commit c4b3bad
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down

0 comments on commit c4b3bad

Please sign in to comment.