Skip to content

Commit 91c35a9

Browse files
committed
Improve lisibility
1 parent 3d4de86 commit 91c35a9

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
Vim-php-cs-fixer by steph_py
2-
============================
1+
Vim-php-cs-fixer
2+
================
33

44
Integrate [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) created by fabpot.
55

6-
This plugin will execute the php-cs-fixer fix command on the directory where you launch the command.
6+
This plugin will execute the `php-cs-fixer` command on the directory where you launch the command. See options to know how to customize that.
77

8-
Options available:
8+
**Options available**:
99

1010
```viml
1111
let g:php_cs_fixer_path = ~/php-cs-fixer.phar "define the path to the php-cs-fixer.phar
1212
let g:php_cs_fixer_level = "all" " which level ?
13-
let g:php_cs_fixer_finder = "Symfony21Finder" " Which finder ?
14-
let g:php_cs_fixer_php_path = "php" " Which php to use
15-
let g:php_cs_fixer_default_mapping = 1 " Enable the mapping by default
13+
let g:php_cs_fixer_finder = "SymfonyFinder" " Which finder ?
14+
let g:php_cs_fixer_php_path = "php" " Path to PHP
15+
let g:php_cs_fixer_default_mapping = 1 " Enable the mapping by default (<leader>pcd)
1616
let g:php_cs_fixer_dry_run = 0 " Call command with dry-run option
1717
```
1818

@@ -23,3 +23,15 @@ If you want to change it:
2323
```viml
2424
map <leader>pcd :call PhpCsFixerFix(expand('%:p:h'))<CR>
2525
```
26+
27+
# Installation
28+
29+
Via **[Vundle](https://github.com/gmarik/vundle)**, add:
30+
31+
```viml
32+
Bundle 'stephpy/vim-php-cs-fixer'
33+
```
34+
35+
To see how to install `php-cs-fixer`, look at [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) repository.
36+
37+
If you see any improvement or question, contribute or create an issue

0 commit comments

Comments
 (0)