README.md in danger-php_codesniffer-0.1.3 vs README.md in danger-php_codesniffer-0.1.4
- old
+ new
@@ -1,16 +1,40 @@
+[![Gem](https://img.shields.io/gem/v/danger-php_codesniffer.svg)](https://rubygems.org/gems/danger-php_codesniffer) [![Build Status](https://travis-ci.org/Golface/danger-php_codesniffer.svg?branch=master)](https://travis-ci.org/Golface/danger-php_codesniffer)
+
# danger-php_codesniffer
-A description of danger-php_codesniffer.
+[Danger](https://github.com/danger/danger) plugin for [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
## Installation
- $ gem install danger-php_codesniffer
+```
+$ gem install danger-php_codesniffer
+```
## Usage
- Methods and attributes from this plugin are available in
- your `Dangerfile` under the `php_codesniffer` namespace.
+Detect your PHP violations of a defined coding standard. The plugin will post a comment on PR/MR on your Github or Gitlab project.
+
+Dangerfile:
+
+```
+php_codesniffer.exec
+```
+
+Ignore file/path and use specific coding standard:
+
+```
+php_codesniffer.ignore = "./vendor"
+php_codesniffer.standard = "CodeIgniter"
+php_codesniffer.exec
+```
+
+Only check new and modified file:
+
+```
+php_codesniffer.standard = "PSR2"
+php_codesniffer.exec
+```
## Development
1. Clone this repo
2. Run `bundle install` to setup dependencies.