Skip to content

Commit

Permalink
docs(readme): enhance
Browse files Browse the repository at this point in the history
  • Loading branch information
azinit authored Dec 5, 2020
1 parent 06d722d commit c6fc7b7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ Actool rules for ESLint to validate code / comments actuality and relevance.
<!-- TODO [**Propose or contribute a new rule ➡**](.github/contributing.md) -->
> **DISCLAIMER**: Work in process, and for a while - here is *approximate* description
> **GET STARTED:** Refer to our [overiew doc](/docs/overview.md) for quick explanation of features and motivation
<!-- NOTE: uncomment later if needed
## Table of contents
Expand All @@ -39,6 +37,8 @@ Actool rules for ESLint to validate code / comments actuality and relevance.
## Usage
> **Requirement:** Make sure your repository have the *git history*
> **Get started:** Refer to our [overiew doc](/docs/overview.md) for quick explanation of features and motivation
* If you don't have ESLint yet configured for your project, follow [these instructions](https://github.com/eslint/eslint#installation-and-usage).
* Install `eslint-plugin-actool` using `npm` (or `yarn`) for you project or globally:

Expand Down

0 comments on commit c6fc7b7

Please sign in to comment.