Skip to content

Commit 9bbc0bb

Browse files
Uploading the design of the project in README.md
1 parent 5718875 commit 9bbc0bb

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

+33-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,38 @@
1-
### Hexlet tests and linter status:
1+
# Differ
2+
23
[![Actions Status](https://github.com/NikolaiProgramist/php-project-48/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/NikolaiProgramist/php-project-48/actions) [![tests-check](https://github.com/NikolaiProgramist/php-project-48/actions/workflows/tests-check.yml/badge.svg)](https://github.com/NikolaiProgramist/php-project-48/actions/workflows/tests-check.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/b070d4d02aad3ce48e32/maintainability)](https://codeclimate.com/github/NikolaiProgramist/php-project-48/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/b070d4d02aad3ce48e32/test_coverage)](https://codeclimate.com/github/NikolaiProgramist/php-project-48/test_coverage)
34

4-
### Asciinema:
5+
## About
6+
7+
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**.
11+
If the files do not exist, the utility will notify you about it.
12+
13+
## Prerequisites
14+
15+
+ Linux, MacOS, WSL
16+
+ PHP >=8.3
17+
+ Composer
18+
+ Make
19+
+ Git
20+
21+
## Install
22+
23+
```bash
24+
git clone https://github.com/NikolaiProgramist/php-project-48.git
25+
cd php-project-48
26+
make install
27+
```
28+
29+
## Run
30+
31+
```bash
32+
php bin/gendiff --format=stylish file1.json file2.json
33+
```
34+
35+
## Examples in asciinema:
536

637
#### JSON
738

0 commit comments

Comments
 (0)