Skip to content

Commit c89856a

Browse files
committed
Add usage and description to README.md
1 parent ca57d32 commit c89856a

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
# PHP-CS-Fixer Config
22

3-
> TODO
3+
This package contains the `PHP-CS-Fixer` configuration that I use on all projects. It is best used with a Laravel application (but can be used very easily w/ any PHP project -- copy the `.php_cs` in the root directory to your project after installing via Composer).
4+
5+
I have spent a lot of time building of this configuration file over the years. Feel free to open up a PR if you think a new rule should be added to the configuration.
6+
7+
## Install the package
8+
9+
```bash
10+
composer require erikgall/php-cs-fixer-config
11+
```
12+
13+
## Commands / Usage
14+
15+
### Running Install Command (Laravel)
16+
17+
```bash
18+
php artisan fixer:install
19+
```
20+
21+
### Running Fix Command (Laravel)
22+
23+
```bash
24+
php artisan fix
25+
```

0 commit comments

Comments
 (0)