Skip to content

Commit 0ca2b5f

Browse files
authored
Merge pull request phpmetrics#480 from kudashevs/feature/readme-fix
Update README.md fix the code block with quick start example.
2 parents 66eee14 + dad2b7c commit 0ca2b5f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,14 @@ PhpMetrics provides metrics about PHP project and classes, with beautiful and re
2222
## Quick start
2323

2424
Follow the [quick start guide](https://phpmetrics.github.io/website/getting-started/) to get started.
25-
composer require phpmetrics/phpmetrics --dev
26-
php ./vendor/bin/phpmetrics --report-html=myreport <folder-to-analyze>
27-
25+
```bash
26+
# install the package as a dev dependency
27+
composer require phpmetrics/phpmetrics --dev
28+
29+
# run PHPMetrics to analyze a folder and generate a report
30+
php ./vendor/bin/phpmetrics --report-html=myreport <folder-to-analyze>
31+
```
32+
2833
Then open the generated `./myreport/index.html` file in your browser.
2934

3035
> You can use a [configuration file](https://phpmetrics.github.io/website/configuration/) to customize

0 commit comments

Comments
 (0)