Skip to content

Commit c9b0e5b

Browse files
authored
Merge pull request #27 from Aeliot-Tm/update-documentation
Update documentation
2 parents d3ff768 + 60ce2aa commit c9b0e5b

File tree

2 files changed

+49
-4
lines changed

2 files changed

+49
-4
lines changed

README.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,55 @@ So, it's some work around till baseline will be implemented in the PHP CS Fixer.
1313

1414
### Installation
1515

16-
Download PHAR directly to root directory of the project or in another place as you wish.
16+
There are few ways of installation:
17+
1. [Phive](#phive)
18+
2. [Composer](#composer)
19+
3. [Downloading of PHAR directly](#downloading-of-phar-directly)
20+
21+
#### Phive
22+
23+
You can install this package with [Phive](https://phar.io/). It permits you to install package by one console command
24+
without extending dependencies in your composer-files.
25+
```shell
26+
phive install php-cs-fixer-baseline
27+
```
28+
29+
Sometimes you may need to update database of package-aliases of PHIVE. See [issue #3](https://github.com/Aeliot-Tm/php-cs-fixer-baseline/issues/3)
30+
So, just call console command for it:
31+
```shell
32+
phive update-repository-list
33+
```
34+
35+
To upgrade this package use the following command:
1736
```shell
18-
curl -O https://github.com/Aeliot-Tm/php-cs-fixer-baseline/releases/download/v1.2.0/pcsf-baseline.phar
37+
phive update php-cs-fixer-baseline
1938
```
2039

21-
Or require package by composer:
40+
#### Composer
41+
42+
You can install this package with [Composer](https://getcomposer.org/doc/03-cli.md#install-i):
2243
```shell
2344
composer require --dev aeliot/php-cs-fixer-baseline
2445
```
2546

47+
#### Downloading of PHAR directly
48+
49+
Download PHAR directly to root directory of the project or in another place as you wish.
50+
```shell
51+
# Do adjust the URL if you need a release other than the latest
52+
wget -O pcsf-baseline.phar "https://github.com/Aeliot-Tm/php-cs-fixer-baseline/releases/latest/download/pcsf-baseline.phar"
53+
wget -O pcsf-baseline.phar "https://github.com/Aeliot-Tm/php-cs-fixer-baseline/releases/latest/download/pcsf-baseline.phar.asc"
54+
55+
# Check that the signature matches
56+
gpg --verify pcsf-baseline.phar.asc pcsf-baseline.phar
57+
58+
# Check the issuer (the ID can also be found from the previous command)
59+
gpg --keyserver hkps://keys.openpgp.org --recv-keys 83F9945BC33EC39E9710206C8B4927076BA50A83
60+
61+
rm pcsf-baseline.phar
62+
chmod +x pcsf-baseline.phar
63+
```
64+
2665
### Configuration
2766

2867
1. Extract `Finder` from the config of PHP CS Fixer to the separate file.

composer.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
{
22
"name": "aeliot/php-cs-fixer-baseline",
33
"type": "library",
4-
"description": "Provide base line for CS Fixer",
4+
"description": "Baseline for PHP CS Fixer",
55
"license": "MIT",
6+
"authors": [
7+
{
8+
"name": "Anatoliy Melnikov",
9+
"email": "[email protected]"
10+
}
11+
],
612
"minimum-stability": "dev",
713
"prefer-stable": true,
814
"require": {

0 commit comments

Comments
 (0)