README: update

Makefile

@@ -12,3 +12,15 @@ show-coverage:
 
 test:
 	poetry run pytest
+
+publish:
+	poetry publish --dry-run
+
+package-install:
+	python3 -m pip install --user dist/*.whl
+
+gendiff:
+	poetry run gendiff
+
+
+.PHONY: install lint test publish gendiff

README.md

@@ -5,6 +5,32 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/9322302759fa8fdd9823/test_coverage)](https://codeclimate.com/github/remortalite/python-project-50/test_coverage)
 
 
+# Генератор отличий
+
+Программа позволяет пользователю получить различия двух json или yaml файлов, и вывести их на печать, либо в json формат.
+
+# Установка и запуск
+
+```bash
+make install
+
+make gendiff
+```
+
+Или можно установить программу в виртуальное окружение:
+
+```bash
+make install package-install publish
+
+gendiff -h
+```
+
+# Аргументы командной строки
+
+`filename{1,2}` -- пути до файлов
+
+`-f`/`--format` [json/plain/stylish] -- формат вывода различий
+
 # Example:
 
 [![asciicast](https://asciinema.org/a/VqUBwDVgdD3umGZYx0qYxiPBa.svg)](https://asciinema.org/a/VqUBwDVgdD3umGZYx0qYxiPBa)