Skip to content

Commit 8cbe2ce

Browse files
Finaly update README.md
1 parent 0d60c03 commit 8cbe2ce

File tree

1 file changed

+32
-6
lines changed

1 file changed

+32
-6
lines changed

README.md

+32-6
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
## About
66

77
This project is a console utility that finds the difference between two files.
8-
This utility can work with such data formats as: **JSON**, **YAML**, **YML**.
9-
You can also see the comparison result in different output formats, for example: **stylish**, **plain**, **json**.
10-
The default output format is **stylish**.
8+
This utility can work with such data formats as: `JSON`, `YAML`, `YML`.
9+
You can also see the comparison result in different output formats, for example: `stylish`, `plain`, `json`.
10+
The default output format is `stylish`.
1111
If the files do not exist, the utility will notify you about it.
1212

1313
## Prerequisites
@@ -18,21 +18,47 @@ If the files do not exist, the utility will notify you about it.
1818
+ Make
1919
+ Git
2020

21-
## Install
21+
## Libraries
22+
23+
+ php-cli-tools
24+
+ docopt
25+
+ functional-php
26+
+ yaml
27+
28+
## Install project
29+
30+
Downloading the utility and installing dependencies
2231

2332
```bash
2433
git clone https://github.com/NikolaiProgramist/php-project-48.git
2534
cd php-project-48
2635
make install
2736
```
2837

38+
Give the binary file execution rights
39+
40+
```bash
41+
sudo chmod +x bin/gendiff
42+
```
43+
2944
## Run
3045

46+
To use the utility, run the binary file and specify the output format (`stylish` by default).
47+
Also pass the paths to the two files you need.
48+
49+
```bash
50+
bin/gendiff --format=stylish file1.json file2.json
51+
```
52+
53+
You can also choose the second output format `plain`
54+
3155
```bash
32-
php bin/gendiff --format=stylish file1.json file2.json
56+
bin/gendiff --format=plain file1.json file2.json
3357
```
3458

35-
## Examples in asciinema:
59+
Instead of the flag `--format`, you can use the short version `-f`
60+
61+
## Examples:
3662

3763
[![asciicast](https://asciinema.org/a/703225.svg)](https://asciinema.org/a/703225)
3864

0 commit comments

Comments
 (0)