docs: it usually is used as dev dependency

mdx-js · Jul 29, 2019 · e4f24c9 · e4f24c9
1 parent f0ab288
commit e4f24c9
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -10,14 +10,18 @@
 
 > [ESLint](https://eslint.org/) Parser/Plugin for [MDX](/~https://github.com/mdx-js/mdx)
 
+## Peer Dependency
+
+Please use `eslint >= 6.0.0`.
+
 ## Install
 
 ```sh
 # yarn
-yarn add @rxts/eslint-plugin-mdx
+yarn add -D @rxts/eslint-plugin-mdx
 
 # npm
-npm i @rxts/eslint-plugin-mdx
+npm i -D @rxts/eslint-plugin-mdx
 ```
 
 ## Usage

diff --git a/test/test.mdx b/test/test.mdx
@@ -1,3 +1,8 @@
+---
+name: FollowReveal
+route: /follow-reveal
+---
+
 import { Test } from './test'
 
 # Hello