patched readme

Author: quicklybly

README.md

@@ -1,20 +1,23 @@
-[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/9A22t-SS)
-Разработать standalone приложение, которое имеет следующие возможности:
+# Bytecode Analyzer
 
-Принимает на вход проект в виде .jar файла
-С помощью библиотеки для манипуляции байткодом (ASM) посчитать и вывести следующие метрики:
-* Максимальная глубина наследования
-* Средняя глубина наследования
-* Метрика ABC (assignment-ом является факт записи в локальную переменную istore, astore и т.д.)
-* Среднее количество переопределенных методов
-* Среднее количество полей в классе
+## Overview
 
-Метрики должны выводиться как в консоль, так и в заданный пользователем файл в машинно-читаемом формате JSON
+This is a simple standalone bytecode analyzer application that analyzes Java `.jar` files using the ASM library.
+It calculates several code metrics and outputs them both to the console and a user-specified JSON file.
 
-Дедлайн: 03.12.2025 23:59
+## Features
 
-Методические материалы: используйте visitor-ы
+The application calculates the following metrics:
 
-Гайд по использованию ASM: https://asm.ow2.io/asm4-guide.pdf
+- **Maximum Inheritance Depth (MID)**
+- **Average Inheritance Depth**
+- **ABC Metric** (based on assignments - detected via `istore`, `astore`, etc.)
+- **Average Number of Overridden Methods per Class**
+- **Average Number of Fields per Class**
 
-Дополнительное (необязательное задание): сделайте агента для сбора покрытия по строчкам
+Results are printed to the console or saved in a machine-readable JSON format.
+
+## Module Structure
+
+- analyzer - main module
+- example - example module, which classes packed in jar for analysis, see IntegrationTest.java

TASK.md

@@ -0,0 +1,19 @@
+Разработать standalone приложение, которое имеет следующие возможности:
+
+Принимает на вход проект в виде .jar файла
+С помощью библиотеки для манипуляции байткодом (ASM) посчитать и вывести следующие метрики:
+* Максимальная глубина наследования
+* Средняя глубина наследования
+* Метрика ABC (assignment-ом является факт записи в локальную переменную istore, astore и т.д.)
+* Среднее количество переопределенных методов
+* Среднее количество полей в классе
+
+Метрики должны выводиться как в консоль, так и в заданный пользователем файл в машинно-читаемом формате JSON
+
+Дедлайн: 03.12.2025 23:59
+
+Методические материалы: используйте visitor-ы
+
+Гайд по использованию ASM: https://asm.ow2.io/asm4-guide.pdf
+
+Дополнительное (необязательное задание): сделайте агента для сбора покрытия по строчкам