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 c6fc7b7 commit 014319e
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,13 @@ 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
* Refer to our [overiew doc](/docs/overview.md) for **quick explanation of features and conception**
* 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:

```sh
npm install eslint-plugin-actool --save-dev # install for your project
npm install eslint-plugin-actool -g # or install globally
$ npm install eslint-plugin-actool -D # install for your project as devDep
$ npm install eslint-plugin-actool -g # or install globally
```

* Add `eslint-plugin-actool` to the `plugins` option of your `.eslintrc`:
Expand Down

0 comments on commit 014319e

Please sign in to comment.