Skip to content

Commit 5581083

Browse files
committed
* update README.md
1 parent 7c36a10 commit 5581083

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,45 @@
22

33
## Installation
44

5+
### Via Composer
6+
7+
```bash
8+
composer require zhouyl/phpfmt-tool
9+
```
10+
11+
### Configuration file lookup order
12+
13+
1. $PWD/.phpfmt.ini (customize)
14+
2. $HOME/.phpfmt/.phpfmt.ini (global)
15+
16+
### Customize the configuration file
17+
18+
```bash
19+
cp vendor/zhouyl/phpfmt-tool/.phpfmt.ini .
20+
```
21+
22+
### Customize the default formatting directories (e.g. laravel 5.x)
23+
24+
```bash
25+
echo "./app ./bootstrap ./database" > ./.fmtdirs
526
```
27+
28+
### Usage
29+
30+
```bash
31+
cd /workspace/myapplication
32+
vendor/bin/phpfmt .
33+
```
34+
35+
## Global Installation
36+
37+
```bash
638
wget --no-check-certificate https://github.com/zhouyl/phpfmt-tool/raw/master/phpfmt -O /usr/local/bin/phpfmt
739
chmod +x /usr/local/bin/phpfmt
40+
cd /workspace/myaplication
41+
phpfmt .
842
```
943

10-
## Usage
44+
## License
1145

46+
The MIT License (MIT). Please see [License File](LICENSE) for more information.

0 commit comments

Comments
 (0)