feat: prittier README.md with badges

.github/workflows/code-check.yml

@@ -1,4 +1,4 @@
-name: Checks
+name: Linters and tests
 on: [pull_request]
 
 jobs:

README.md

@@ -2,7 +2,18 @@
 
 Async Yandex Tracker Client based on aiohttp and pydantic (v2)
 
-# Current library capabilities
+[![Python](https://img.shields.io/badge/python-^3.11-blue)](https://www.python.org/)
+[![Code linter: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
+[![Linters](https://github.com/danfimov/ya_tracker_client/actions/workflows/code-check.yml/badge.svg)](https://github.com/danfimov/ya_tracker_client/actions/workflows/code-check.yml)
+
+## Explanations about naming
+
+- All `self` properties renamed to `url` cause it's incompatible with Python;
+- All `camelCase` properties renamed to `pythonic_case`;
+- All datetime values converted to python's `datetime.datetime` objects;
+- Methods named by author, cause Yandex API has no clear method names.
+
+## Current library capabilities
 
 - Working with queues
 - Getting information about issues, priorities and transitions