Skip to content

Commit

Permalink
fix: eslint docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sergiokopplin committed Jul 12, 2022
1 parent 9ab648c commit af36af4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 5 deletions.
6 changes: 6 additions & 0 deletions tools/eslint/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# @kopplin/eslint

## 0.0.2

### Patch Changes

- docs updates

## 0.0.1

### Patch Changes
Expand Down
10 changes: 6 additions & 4 deletions tools/eslint/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# @kopplin/eslint-config
# @kopplin/eslint

[![npm version](https://badge.fury.io/js/%40kopplin%2Feslint-config.svg)](https://badge.fury.io/js/%40kopplin%2Feslint-config)
[![npm version](https://badge.fury.io/js/%40kopplin%2Feslint.svg)](https://badge.fury.io/js/%40kopplin%2Feslint)

Kopplin's shared [ESLint](https://eslint.org/) configuration.

## Setup

1. Install the package.

```sh
npm install -D @kopplin/eslint-config eslint
npm install -D @kopplin/eslint eslint
```

2. Add to your .eslintrc

```json
{
"extends": ["@kopplin/eslint-config"],
"extends": ["@kopplin/eslint"],
"parserOptions": {
"project": "tsconfig.json"
}
Expand Down
2 changes: 1 addition & 1 deletion tools/eslint/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@kopplin/eslint",
"version": "0.0.1",
"version": "0.0.2",
"description": "Shared ESLint config",
"author": "Sergio Kopplin <[email protected]>",
"main": "index.js",
Expand Down

0 comments on commit af36af4

Please sign in to comment.