readme fake api

[h1alexbel]

closes #331

---

PR-Codex overview

This PR introduces a Fake API for mocking eo-kafka, allowing manipulation of an in-memory XML document instead of a real Kafka broker.

Detailed summary:

• Added FkBroker class for creating an in-memory XML document
• Added FkProducer class for creating a fake producer
• Added FkConsumer class for creating a fake consumer
• Added example code demonstrating the usage of the Fake API
• Added documentation explaining the usage of the Fake API
• Added support for closing fake producers and consumers

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

[zoeself]

@h1alexbel thank you for your Pull Request. I'll assign someone to review it soon.

If this PR solves a todo from the code, please don't forget to remove it.

[zoeself]

@h1alexbel please review this Pull Request. Deadline (when it should be merged or closed) is 2023-07-01T14:19:05.755256.

You should check if the requirements have been implemented (partially or in full), if there are unit tests covering the changes and if the CI build passes. Feel free to reject the PR or ask for changes if it's too big or not clear enough.

Estimation here is 30 minutes, that's how much you will be paid. You will be paid even if this PR gets rejected.

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (e93a62a) 98.23% compared to head (8e56a87) 98.23%.

Additional details and impacted files

@@            Coverage Diff            @@
##             master     #397   +/-   ##
=========================================
  Coverage     98.23%   98.23%           
  Complexity      164      164           
=========================================
  Files            75       75           
  Lines           453      453           
  Branches          1        1           
=========================================
  Hits            445      445           
  Misses            8        8           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[h1alexbel]

@rultor merge

[rultor]

@rultor merge

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

[rultor]

@rultor merge

@h1alexbel Done! FYI, the full log is here (took me 2min)

[zoeself]

@h1alexbel thank you for resolving this ticket. I've just added it to your active invoice. You can always check all your invoices and more on the Contributor Dashboard.