Merge branch 'main' of github.com:ZLOI27/python-project-50

Author: ZLOI27

README.md

@@ -1,28 +1,75 @@
-## Difference Calculator
-This program takes two files as arguments, compares them, and outputs the differences between them.
-### Hexlet tests and linter status:
+# Hexlet tests and linter status:
 [![Actions Status](https://github.com/ZLOI27/python-project-50/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/ZLOI27/python-project-50/actions)
 [![Python CI](https://github.com/ZLOI27/python-project-50/actions/workflows/pyci.yml/badge.svg)](https://github.com/ZLOI27/python-project-50/actions/workflows/pyci.yml)
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ZLOI27_python-project-50&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=ZLOI27_python-project-50)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ZLOI27_python-project-50&metric=coverage)](https://sonarcloud.io/summary/new_code?id=ZLOI27_python-project-50)
 
-### Setup all dependencies
+
+# gendiff configuration file diff tool
+
+gendiff is a tool for easily comparing configuration files and displaying the differences between them in various formats. With gendiff, you can:
+
+- Get diffs in different formats: from the human-readable stylish format to the simple plain format, and even json.
+- Work with different file types, supporting YAML and JSON formats.
+- Easily integrate with other tools and scripts for automatic configuration comparisons.
+
+### Features:
+- Simple command-line interface.
+- Support for extendable output formats.
+- Comparison of nested data structures.
+- Suitable for working with any type of configuration or data files.
+
+### Supported Output Formats:
+- *Stylish*: Beautiful and human-readable output.
+- *Plain*: Simple text-based output.
+- *JSON*: Output in JSON format for integration with other tools.
+
+# Installation Guide for gendiff
+
+Follow the steps below to set up and install the gendiff project on your local machine.
+
+### Clone the Repository
+
+Start by cloning the repository from GitHub:
+
+```bash
+https://github.com/ZLOI27/python-project-50.git
+```
+
+### Installation
+Navigate into the project directory and install the required dependencies:
+
+```bash
+cd python-project-50
+```
 ```bash
 make install
 ```
 
-### Install package global
+### Install the package globally
 ```bash
 make build
+```
+```
 make package-install
 ```
 
-### Run tests
+### Run the tool
+
+```bash
+gendiff -f <format> <first_file> <second_file>
+```
+
+Replace `<first_file>`, `<second_file>`, and `<format>` with the appropriate file paths and desired output format (such as `stylish`, `plain`, or `json`).
+
+## Tests
+
+### Run the tests
 ```bash
 make test
 ```
 
-### Run tests with coverage, run with test-files and ruff check
+### Run the tests with coverage, run with test-files and ruff check
 ```bash
 make full-check
 ```
@@ -35,3 +82,6 @@ make full-check
 
 ### Asciinema gendiff of two trees
 [![asciicast](https://asciinema.org/a/UcwLpdkKRdO1xMTVAh6NN2F2S.svg)](https://asciinema.org/a/UcwLpdkKRdO1xMTVAh6NN2F2S)
+
+### Asciinema gendiff format plain
+[![asciicast](https://asciinema.org/a/406KH8KdnWPyk14AtZLGKGdMg.svg)](https://asciinema.org/a/406KH8KdnWPyk14AtZLGKGdMg)