Skip to content

Commit fbe23a9

Browse files
committed
- update readme
1 parent 0ced003 commit fbe23a9

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ based on Magento 2 coding standards but tuned to be less annoying!
66

77
## Usage
88

9+
### Usage on a regular Space48 Warden based Magento 2 project:
10+
911
After pulling and installing/updating project locally run following command to update local git hooks and install npm packages:
1012
```shell
1113
make linters-init
@@ -25,6 +27,11 @@ When fixing errors, to see predicted linters output you can instead of trying to
2527
make precommit
2628
```
2729

30+
### Usage on other projects
31+
32+
Run `vendor/bin/grumphp git:init` to add githook
33+
Grumphp will sniff your code on any git commit
34+
2835
### Ignoring Rules
2936
in the linters output you will see hints with rule names being violated. If for some reason you can not fix violated rule
3037
feel free to ignore it using Suppress Warning comment corresponding concrete linter type (see hints in output or google).
@@ -52,6 +59,9 @@ make analyse
5259

5360
Add Code Quality tool to the Magento Project:
5461

62+
### Warning!
63+
Eslisnt and Stylelint requires **NodeJs v10** or higher.
64+
5565
### Installation on a regular _Space48 Warden based Magento 2_ project:
5666

5767
On Magento versions **earlier than 2.4** add following to 'require' section of project's `composer.json`:

0 commit comments

Comments
 (0)