diff --git a/README.md b/README.md index 0358380..0b91759 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ This package provides utility functions and classes for make ESLint custom rules For examples: - [getStaticValue](https://eslint-utils.mysticatea.dev/api/ast-utils.html#getstaticvalue) evaluates static value on AST. -- [PatternMatcher](https://eslint-utils.mysticatea.dev/api/ast-utils.html#patternmatcher-class) finds a regular expression pattern as handling escape sequences. - [ReferenceTracker](https://eslint-utils.mysticatea.dev/api/scope-utils.html#referencetracker-class) checks the members of modules/globals as handling assignments and destructuring. ## 📖 Usage diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index edc74c0..6ed8864 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -12,16 +12,12 @@ module.exports = { docsBranch: "master", editLinks: true, - nav: [ - { text: "Guide", link: "/guide/getting-started" }, - { text: "API Reference", link: "/api/ast-utils" }, - ], sidebar: { "/": [ { title: "Guide", collapsable: false, - children: ["/guide/getting-started"], + children: ["/"], }, { title: "API Reference", diff --git a/docs/README.md b/docs/README.md index 3a20ec3..d00b86f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,17 +1,4 @@ ---- -home: true -actionText: Get Started → -actionLink: /guide/getting-started -features: -- title: Scope Utilities - details: Finding the specific global variables and their members with tracking assignments, finding variables, etc... -- title: AST Utilities - details: Computing the runtime value of a node, Getting the property name of a Property|MemberExpression|MemberExpression node, etc... -- title: Token Utilities - details: Distinguishing the token types of a given token, etc... ---- - -
+# Getting Started [![npm version](https://img.shields.io/npm/v/eslint-utils.svg)](https://www.npmjs.com/package/eslint-utils) [![Downloads/month](https://img.shields.io/npm/dm/eslint-utils.svg)](http://www.npmtrends.com/eslint-utils) @@ -19,4 +6,26 @@ features: [![Coverage Status](https://codecov.io/gh/mysticatea/eslint-utils/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/eslint-utils) [![Dependency Status](https://david-dm.org/mysticatea/eslint-utils.svg)](https://david-dm.org/mysticatea/eslint-utils) -
+## 🏁 Goal + +`eslint-utils` package provides utility functions and classes for make ESLint custom rules. + +## 💿 Installation + +Use [npm](https://www.npmjs.com/) or a compatible tool to install. + +``` +npm install eslint-utils +``` + +::: tip Requirements +`eslint-utils` requires Node.js `6.5.0` or newer versions. +::: + +## 📖 Usage + +```js +const utils = require("eslint-utils") + +// use it to define rules... +``` diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md deleted file mode 100644 index 31e6685..0000000 --- a/docs/guide/getting-started.md +++ /dev/null @@ -1,21 +0,0 @@ -# Getting Started - -## Installation - -Use [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install. - -``` -npm install eslint-utils -``` - -::: tip Requirements -`eslint-utils` requires Node.js `6.5.0` or newer versions. -::: - -## Usage - -```js -const utils = require("eslint-utils") - -// use it to define rules... -```