Skip to content

Commit e1f0975

Browse files
committed
Docs
1 parent 79b8067 commit e1f0975

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,20 @@ For details on PSR-2-R see [fig-rectified-standards](https://github.com/php-fig-
1010

1111
Documentation @ [/docs/](docs).
1212

13-
## PHP-CS Sniffs
13+
## Included sniffs
14+
The following sniffers are bundles together as `PSR2R` already, but you can
15+
also use them standalone/separately in any way you like.
1416

15-
This uses [squizlabs/PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer/).
17+
**Currently PSR2R ships with over 128 sniffs.**
18+
19+
* [List of included sniffs](docs/sniffs.md)
20+
21+
This library uses [squizlabs/PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer/).
1622
It can detect all issues and fix some of them automatically and is ideal for CI integration
1723
(travis, jenkins, circlci etc).
1824

1925
### Usage
26+
2027
#### How to use for your project
2128
Most likely you are using composer. As such, put it into the require-dev dependencies:
2229
```

docs/README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,9 @@ For details on PSR-2-R see [fig-rectified-standards](https://github.com/php-fig-
44
## Documentation on the sniffer itself
55
This uses and extends [squizlabs/PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer/).
66

7-
Runs on all OS, tested on Unix and Windows.
8-
9-
## Included sniffs
10-
The following sniffers are bundles together with `PSR-2-R` already, but you can
11-
also use them standalone/separately in any way you like.
12-
13-
**Currently PSR2R ships with over 120 sniffs.**
14-
15-
[List of included sniffs](sniffs.md)
16-
177
Most of the sniffs also provide auto-fixing using `-f` option where it is possible.
188

19-
## Open Tasks
20-
* It would be nice if some of these sniffers find their way into the contrib section of the original sniffer repo.
21-
If anyone wants to contribute and add those there, that would be awesome.
22-
* More tests
9+
Runs on all OS, tested on Unix and Windows.
2310

2411
## Using the original phpcs and phpcbf command tools
2512
Of course you can also use the original cli commands:
@@ -170,3 +157,8 @@ Run
170157
```
171158
composer docs
172159
```
160+
161+
## Open Tasks
162+
* It would be nice if some of these sniffers find their way into the contrib section of the original sniffer repo.
163+
If anyone wants to contribute and add those there, that would be awesome.
164+
* More tests

0 commit comments

Comments
 (0)