Readme

[dukris]

Closes #18
Closes #4

---

PR-Codex overview

This PR adds badges and project information to the README.md file.

Detailed summary

• Added badges for EO principles, DevOps, IntelliJ IDEA, mvn, codecov, and PDD status.
• Added project architect information.
• Added project functionality details.
• Added instructions on how to run the app locally.
• Added instructions on how to contribute to the project.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ebc419c) 28.34% compared to head (f8b179f) 28.34%.

Additional details and impacted files

@@            Coverage Diff            @@
##             master      #20   +/-   ##
=========================================
  Coverage     28.34%   28.34%           
  Complexity       23       23           
=========================================
  Files            15       15           
  Lines           127      127           
  Branches          4        4           
=========================================
  Hits             36       36           
  Misses           90       90           
  Partials          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[h1alexbel]

@hizmailovich let's add a description of this repo too.

1. Why is it for?
2. What it does?
3. What is the main functionality?
   and so on.

[h1alexbel]

@hizmailovich lets merge

[dukris]

@rultor merge

[rultor]

@rultor merge

@hizmailovich OK, I'll try to merge now. You can check the progress of the merge here

[rultor]

@rultor merge

@hizmailovich Done! FYI, the full log is here (took me 5min)