From b35286a3e1d8e485573f99fc95bcfefb72f431fe Mon Sep 17 00:00:00 2001
From: Stepan Kirushkin <stepan.kirushkin@gmail.com>
Date: Tue, 19 Dec 2023 16:18:01 +0300
Subject: [PATCH] Add CHANGELOG and README. (#2)

- CHANGELOG
- README
---
 CHANGELOG.md |  2 ++
 README.md    | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e69de29..072c581 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -0,0 +1,2 @@
+## 0.0.1
+- Basic flow for usage.
diff --git a/README.md b/README.md
index e69de29..37f2923 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,47 @@
+# Yabeda::RabbitMessaging
+
+Built-in metrics for [TableSync](https://github.com/umbrellio/table_sync) out of the box!
+Patch [rabbit_messaging](https://github.com/umbrellio/rabbit_messaging) gem.
+Works through [Yabeda Framework](https://github.com/yabeda-rb).
+
+## Installation
+
+```ruby
+gem "rabbit_messaging"
+...
+gem "yabeda"
+gem "yabeda-rabbit_messaging"
+```
+
+And then execute:
+
+```sh
+  $ bundle
+```
+
+After application launch gem patch `Rabbit::Receiving::Job` class to collect the metrics.
+
+## Metrics
+
+Metrics representing state of TableSync receiving jobs processing:
+
+- Total number of executed jobs: `rabbit_messages_total` (segmented by `exchange`, `routing_key` and `success` status)
+- Duration of executed jobs: `rabbit_messages_duration` (segmented by `exchange`, `routing_key` and `success` status)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/table_sync.
+
+## License
+
+Released under MIT License.
+
+## Authors
+
+Team Umbrellio
+
+---
+
+<a href="https://github.com/umbrellio/">
+<img style="float: left;" src="https://umbrellio.github.io/Umbrellio/supported_by_umbrellio.svg" alt="Supported by Umbrellio" width="439" height="72">
+</a>