Skip to content

Commit 8145edd

Browse files
committed
Add How to run to README
1 parent aff8018 commit 8145edd

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [Install dependencies](#install-dependencies)
99
- [Create symbolink link](#create-symbolink-link)
1010
- [Include in your project](#include-in-your-project)
11+
- [How to run this project](#how-to-run-this-project)
1112

1213
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1314

@@ -41,8 +42,18 @@ $ composer install
4142
ln -s ~/phpqa/bin/phpqa.php /usr/local/bin/phpqa
4243
```
4344

44-
4545
## Include in your project
4646
```
4747
$ composer require jmolivas/phpqa
48-
```
48+
```
49+
50+
## How to run this project
51+
```
52+
# Make sure you run this command the first time
53+
$ phpqa init
54+
55+
# Run this command to test your project code
56+
$ phpqa analyze --project=php --files=src/
57+
```
58+
59+
> Note: This project is a work-in-progress need some love related to code clean up and testing coverage.

0 commit comments

Comments
 (0)