Skip to content

Commit 4197542

Browse files
authored
Merge pull request #3 from leviy/readme
Add badges and a short description to the README
2 parents 78d7671 + d3661b2 commit 4197542

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# LEVIY Coding Standard
22

3+
[![Build status](https://img.shields.io/travis/leviy/php-coding-standard.svg)](https://travis-ci.org/leviy/php-coding-standard)
4+
[![Packagist version](https://img.shields.io/packagist/v/leviy/coding-standard.svg)](https://packagist.org/packages/leviy/coding-standard)
5+
[![PHP from Packagist](https://img.shields.io/packagist/php-v/leviy/coding-standard.svg)](https://github.com/leviy/php-coding-standard/blob/master/composer.json)
6+
7+
The LEVIY coding standard for PHP code, including a PHPCS ruleset.
8+
39
## Installation
410

511
Install the coding standard using [Composer](https://getcomposer.org/):
@@ -10,18 +16,20 @@ composer require --dev leviy/coding-standard
1016

1117
Create a `phpcs.xml` file containing the following bootstrap code sniffer configuration:
1218

13-
<?xml version="1.0"?>
14-
<ruleset name="LEVIY">
15-
<description>LEVIY</description>
16-
17-
<arg name="extensions" value="php" />
18-
19-
<file>./src</file>
20-
21-
<exclude-pattern>*Test.php</exclude-pattern>
22-
23-
<rule ref="LEVIY"/>
24-
</ruleset>
19+
```xml
20+
<?xml version="1.0"?>
21+
<ruleset name="LEVIY">
22+
<description>LEVIY</description>
23+
24+
<arg name="extensions" value="php" />
25+
26+
<file>./src</file>
27+
28+
<exclude-pattern>*Test.php</exclude-pattern>
29+
30+
<rule ref="LEVIY"/>
31+
</ruleset>
32+
```
2533

2634
An annotated `ruleset.xml` configuration file can be found [here](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml)
2735
where you can see the complete range of features and configuration options that can be used to modify the configuration to your project needs.

0 commit comments

Comments
 (0)