crawl
/
coding-standard
1
0
Fork 0
Code Issues Pull Requests Actions Releases 5 Wiki Activity

Updated README

master
Gertjan Krol 2022-09-18 18:13:06 +02:00
parent a26d99204c
commit b3a56e85e1
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -3,7 +3,7 @@
[![Latest Version on Packagist](https://img.shields.io/packagist/v/crawl/coding-standard.svg?style=flat-square)](https://packagist.org/packages/crawl/coding-standard) [![Latest Version on Packagist](https://img.shields.io/packagist/v/crawl/coding-standard.svg?style=flat-square)](https://packagist.org/packages/crawl/coding-standard)
[![Total Downloads](https://img.shields.io/packagist/dt/crawl/coding-standard.svg?style=flat-square)](https://packagist.org/packages/crawl/coding-standard) [![Total Downloads](https://img.shields.io/packagist/dt/crawl/coding-standard.svg?style=flat-square)](https://packagist.org/packages/crawl/coding-standard)
This package provides rule sets for the Crawl Coding Standard.\ This package provides rule sets for the Crawl Coding Standard.
It requires `squizlabs/php_codesniffer` and some extensions (see [composer.json](composer.json)). It requires `squizlabs/php_codesniffer` and some extensions (see [composer.json](composer.json)).
## Installation ## Installation
@ -15,8 +15,9 @@ composer require crawl/coding-standard --dev
``` ```
## Usage ## Usage
Depending on your project, copy `phpcs-laravel.xml` or `phpcs-package.xml` from `config/` to your project.\ Depending on your project, copy `phpcs-laravel.xml` or `phpcs-package.xml` from `config/` to your project.
**Note:** don't forget to update `Package\Namespace` when using `phpcs-package.xml`.
> **Note:** don't forget to update `Package\Namespace` when using `phpcs-package.xml`.
You can then run PHP Code Sniffer/Beautifier: You can then run PHP Code Sniffer/Beautifier:
```bash ```bash