Skip to content

Commit 8e8cd1c

Browse files
authored
Update README.md
1 parent 6ca3459 commit 8e8cd1c

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
About
2-
=====
1+
phpcs-security-audit v2
2+
=======================
33

4+
About
5+
-----
46
phpcs-security-audit is a set of [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) rules that finds vulnerabilities and weaknesses related to security in PHP code.
57

68
It currently has core PHP rules as well as Drupal 7 specific rules.
@@ -15,7 +17,7 @@ phpcs-security-audit is backed by [Floe design + technologies](https://floedesig
1517

1618

1719
Install
18-
=====
20+
-------
1921

2022
Requires [PHP CodeSniffer](http://pear.php.net/package/PHP_CodeSniffer/) version 3.x with PHP 5.4 or higher.
2123

@@ -30,14 +32,15 @@ composer install
3032
The package is also on [Packagist](https://packagist.org/packages/pheromone/phpcs-security-audit):
3133
```
3234
composer require pheromone/phpcs-security-audit
35+
sh vendor/pheromone/phpcs-security-audit/symlink.sh
3336
./vendor/bin/phpcs --standard=./vendor/pheromone/phpcs-security-audit/example_base_ruleset.xml ./vendor/pheromone/phpcs-security-audit/tests.php
3437
```
3538

3639
If you want to integrate it all with Jenkins, go see http://jenkins-php.org/ for extensive help.
3740

3841

3942
Usage
40-
=====
43+
-----
4144

4245
Simply point to any XML ruleset file and a folder:
4346
```
@@ -63,8 +66,7 @@ FOUND 16 ERROR(S) AND 15 WARNING(S) AFFECTING 22 LINE(S)
6366
6467
```
6568

66-
Drupal details
67-
--------------
69+
#### Drupal note
6870

6971
For the Drupal AdvisoriesContrib you need to change your `/etc/php5/cli/php.ini` to have:
7072
```
@@ -76,7 +78,7 @@ Please note that only Drupal modules downloaded from drupal.org are supported. I
7678

7779

7880
Customize
79-
=========
81+
---------
8082
As in normal PHP CodeSniffer rules, customization is provided in the XML files that are in the top folder of the project.
8183

8284
These global parameters are used in many rules:
@@ -89,7 +91,7 @@ In some case you can force the paranoia mode on or off with the parameter `force
8991

9092

9193
Specialize
92-
==========
94+
----------
9395

9496
If you want to fork and help or just do your own sniffs you can use the utilities provided by phpcs-security-audit rules in order to facilitate the process.
9597

@@ -120,7 +122,7 @@ If you implement any public cms/framework customization please make a pull reque
120122

121123

122124
Annoyances
123-
==========
125+
----------
124126

125127
As any security tools, this one comes with it's share of annoyance. At first a focus on finding vulnerabilities will be done, but later it is planned to have a phase where efforts will be towards reducing annoyances, in particular with the number of false positives.
126128

0 commit comments

Comments
 (0)