Skip to content
This repository was archived by the owner on Oct 30, 2024. It is now read-only.

Commit 704cf79

Browse files
committed
Better README
1 parent c720f4a commit 704cf79

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,23 +90,33 @@ Developer's Information
9090

9191
### Releases
9292

93-
[Latest stable](https://github.com/repejota/phpnats/tree/master)
94-
[Latest dev](https://github.com/repejota/phpnats/tree/develop)
93+
* [Latest stable](https://github.com/repejota/phpnats/tree/master)
94+
* [Latest dev](https://github.com/repejota/phpnats/tree/develop)
95+
96+
* [PHPNats on Packagist](https://packagist.org/packages/repejota/nats)
9597

9698
### Tests
9799

98100
Tests are in the `tests` folder.
99-
To run them, you need `PHPUnit` and execute `make test`.
101+
To run them, you need `PHPUnit` and execute `make test-tdd`.
100102

101103
We also have a BDD test suite under the `spec` folder.
102-
To run the suite, you need `PHPSpec` and execute `make bdd`.
104+
To run the suite, you need `PHPSpec` and execute `make test-bdd`.
105+
106+
You can also execute the all suites ( TDD + BDD ) with `make test`.
103107

104108
### Code Quality
105109

106110
We are using [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer/docs)
107111
to ensure our code follow an high quality standard.
108112

109-
To perform an analysis of the code execute `make cs`.
113+
To perform an analysis of the code execute `make lint`.
114+
115+
There is currently three steps when we lint our code:
116+
117+
* First we lint with php itself `php -l`
118+
* Then we lint with PSR2 standard
119+
* And finally we lint with a custom [ruleset.xml](https://github.com/repejota/phpnats/blob/feature/lint-squiz/ruleset.xml) that checks dockblocks and different performance tips.
110120

111121

112122
Creators

0 commit comments

Comments
 (0)