Skip to content

Commit fa7735f

Browse files
committed
Added docs.
1 parent cb4214b commit fa7735f

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
##PHP DocBlock Checker
2+
3+
A basic CLI (Command Line Interface) tool to verify if your PHP classes have DocBlocks.
4+
5+
###How to install?
6+
7+
**PRE NOTE**: you should have [Composer](https://getcomposer.org/) installed before proceed on these next steps.
8+
9+
1. Run `git clone https://github.com/devdrops/php-docblock-checker.git` on your terminal;
10+
2. Once you've entered the project root folder, run `composer install`;
11+
3. And now you're ready to go! :D
12+
13+
###How to use?
14+
15+
1. Once everything is correctly installed, run `php phpdoccheck -d /full/path/to/your/selection/`. **Remember** that the *-d* flag is required!
16+
2. Then, check the input to fix any fail.

0 commit comments

Comments
 (0)