From 014319e64685a5127e98fdbcdde52b62ef3960c8 Mon Sep 17 00:00:00 2001 From: Ilya Azin Date: Sat, 5 Dec 2020 20:46:49 +0300 Subject: [PATCH] docs(readme): enhance #40 --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4d0b722..84ed9fd 100644 --- a/README.md +++ b/README.md @@ -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`: