Skip to content

Commit f33dbaf

Browse files
committed
Add a README
... with the most basic information about the coding standard.
1 parent 7460623 commit f33dbaf

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
PHP Code Style
2+
=================
3+
4+
Basic, PSR-12 based, coding standard for use by projects in the PHP Parallel Lint GitHub organisation.
5+
6+
## Installation
7+
8+
Install this standard via Composer:
9+
10+
```bash
11+
composer require --dev php-parallel-lint/php-code-style
12+
```
13+
14+
## Using the standard
15+
16+
Once installed for a project, use this standard via the command-line:
17+
```bash
18+
vendor/bin/phpcs . --standard=PHPParallelLint
19+
```
20+
21+
Or use the standard in a project specific PHPCS ruleset:
22+
```xml
23+
<?xml version="1.0"?>
24+
<ruleset name="Project Name">
25+
26+
<rule ref="PHPParallelLint"/>
27+
28+
</ruleset>
29+
```

0 commit comments

Comments
 (0)