Skip to content

Commit 0a7d683

Browse files
docs: update README (#15)
1 parent 8ac38b1 commit 0a7d683

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,15 @@
44
[![Downloads/month](https://img.shields.io/npm/dm/@eslint-community/eslint-utils.svg)](http://www.npmtrends.com/@eslint-community/eslint-utils)
55
[![Build Status](https://github.com/eslint-community/eslint-utils/workflows/CI/badge.svg)](https://github.com/eslint-community/eslint-utils/actions)
66
[![Coverage Status](https://codecov.io/gh/eslint-community/eslint-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/eslint-community/eslint-utils)
7-
[![Dependency Status](https://david-dm.org/eslint-community/eslint-utils.svg)](https://david-dm.org/eslint-community/eslint-utils)
87

98
## 🏁 Goal
109

1110
This package provides utility functions and classes for make ESLint custom rules.
1211

1312
For examples:
1413

15-
- [getStaticValue](https://eslint-utils.mysticatea.dev/api/ast-utils.html#getstaticvalue) evaluates static value on AST.
16-
- [ReferenceTracker](https://eslint-utils.mysticatea.dev/api/scope-utils.html#referencetracker-class) checks the members of modules/globals as handling assignments and destructuring.
14+
- [`getStaticValue`](https://eslint-utils.mysticatea.dev/api/ast-utils.html#getstaticvalue) evaluates static value on AST.
15+
- [`ReferenceTracker`](https://eslint-utils.mysticatea.dev/api/scope-utils.html#referencetracker-class) checks the members of modules/globals as handling assignments and destructuring.
1716

1817
## 📖 Usage
1918

docs/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
[![npm version](https://img.shields.io/npm/v/@eslint-community/eslint-utils.svg)](https://www.npmjs.com/package/@eslint-community/eslint-utils)
44
[![Downloads/month](https://img.shields.io/npm/dm/@eslint-community/eslint-utils.svg)](http://www.npmtrends.com/@eslint-community/eslint-utils)
5-
[![Build Status](https://travis-ci.org/eslint-community/eslint-utils.svg?branch=main)](https://travis-ci.org/eslint-community/eslint-utils)
5+
[![Build Status](https://github.com/eslint-community/eslint-utils/workflows/CI/badge.svg)](https://github.com/eslint-community/eslint-utils/actions)
66
[![Coverage Status](https://codecov.io/gh/eslint-community/eslint-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/eslint-community/eslint-utils)
7-
[![Dependency Status](https://david-dm.org/eslint-community/eslint-utils.svg)](https://david-dm.org/eslint-community/eslint-utils)
87

98
## 🏁 Goal
109

@@ -14,12 +13,12 @@
1413

1514
Use [npm](https://www.npmjs.com/) or a compatible tool to install.
1615

17-
```
16+
```sh
1817
npm install @eslint-community/eslint-utils
1918
```
2019

2120
::: tip Requirements
22-
`@eslint-community/eslint-utils` requires Node.js `10` or newer versions.
21+
`@eslint-community/eslint-utils` requires Node.js `^12.22.0 || ^14.17.0 || >=16.0.0`.
2322
:::
2423

2524
## 📖 Usage

0 commit comments

Comments
 (0)