Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NielsdeBlaauw authored Jan 17, 2019
1 parent a76dd9c commit 49c77ac
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ By default this script:
You can gradually improve documenation on projects by starting with relatively
high limits and slowly moving these limits down.

## Installation

For now you have to install the beta version.

`composer require --dev niels-de-blaauw/php-doc-check:^0.1.0@dev`

## Usage

```
Expand Down Expand Up @@ -79,4 +85,4 @@ regardless if they have a DocBlock?
A: You *should* refactor very complex functions. However, adding DocBlocks
for complex function is often easier and safer. This tool only checks the
availability of this type of documentation. Other tools, like [php Mess Detector](https://github.com/phpmd/phpmd),
can help you limit complexity.
can help you limit complexity.

0 comments on commit 49c77ac

Please sign in to comment.