Skip to content

Commit e4f24c9

Browse files
committed
docs: it usually is used as dev dependency
1 parent f0ab288 commit e4f24c9

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,18 @@
1010

1111
> [ESLint](https://eslint.org/) Parser/Plugin for [MDX](https://github.com/mdx-js/mdx)
1212
13+
## Peer Dependency
14+
15+
Please use `eslint >= 6.0.0`.
16+
1317
## Install
1418

1519
```sh
1620
# yarn
17-
yarn add @rxts/eslint-plugin-mdx
21+
yarn add -D @rxts/eslint-plugin-mdx
1822

1923
# npm
20-
npm i @rxts/eslint-plugin-mdx
24+
npm i -D @rxts/eslint-plugin-mdx
2125
```
2226

2327
## Usage

test/test.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: FollowReveal
3+
route: /follow-reveal
4+
---
5+
16
import { Test } from './test'
27

38
# Hello

0 commit comments

Comments
 (0)