Skip to content

Commit b5b26b7

Browse files
author
Nick
authored
Updated documentation
1 parent dafd062 commit b5b26b7

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Space48 Code Quality tool
22

3-
A module that helps to easily apply static code analysers to the project`s code.
4-
It uses [grumphp](https://github.com/phpro/grumphp) under the hood and has predefined set of rules
5-
based on Magento 2 coding standards and tuned to be less annoying.
3+
A module that helps to easily apply static code analysers to the project's code.
4+
It uses [grumphp](https://github.com/phpro/grumphp) under the hood with a predefined set of rules
5+
based on Magento 2 coding standards but tuned to be less annoying!
66

77
## Usage
8+
89
After pulling and installing a project locally just run following command to update local git hooks
910
and install npm packages inside Docker container:
1011
```shell
@@ -26,8 +27,8 @@ make analyse
2627
Add Code Quality tool to the Magento Project:
2728

2829
### Installation on a regular _Space48 Warden based Magento 2_ project:
29-
####NOTE!
30-
On Megento versions **earlier than 2.4** add following to 'require' section of project's `composer.json`:
30+
31+
On Magento versions **earlier than 2.4** add following to 'require' section of project's `composer.json`:
3132
```
3233
"require": {
3334
...
@@ -48,7 +49,7 @@ git add ruleset.xml phpmd.xml .eslintrc grumphp.yml
4849
#### 2. Add following to project`s 'Makefile':
4950
```makefile
5051
win:
51-
open 'https://de-app.avaeta.test'
52+
open 'https://de-app.example.test'
5253
@echo "You are successful."
5354

5455
linters-init: # init linters on local machine

0 commit comments

Comments
 (0)