From 82adb7a3e236cf0871670b592ed5d9f951d9b229 Mon Sep 17 00:00:00 2001
From: jhyangxyz <72127840+jhyangxyz@users.noreply.github.com>
Date: Wed, 30 Sep 2020 11:19:49 +0000
Subject: [PATCH] Create README.md

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..64fbcf2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# Messenger Version Control
+
+![CodeStyle](https://github.com/fjogeleit/prometheus-messenger-middleware/workflows/CodeStyle/badge.svg)
+
+A Simple Bunlde to version your Symfony Messenger messages.
+
+* Versionning of a message
+* Requeuing consumers that has different version with the concerned message
+
+## Dependencies
+* PHP >= 7.4
+* symfony/messenger
+
+## Installation
+
+```bash
+composer require jhyangxyz/messenger-version-control
+```
+
+## Usage
+
+Configure this Middleware to your MessageBus
+
+### Symfony Basic Example
+
+#### Register the Bundle if not done automaticaly
+
+```yaml
+<?php
+
+return [
+    ...,
+    Jhyangxyz\MessengerVersionControl\JhyangxyzMessengerVersionControlBundle::class => ['all' => true],
+];
+
+```
+
+#### Configure Middleware
+
+```yaml
+framework:
+    messenger:
+        buses:
+            message.bus.commands:
+                middleware:
+                    - jhyangxyz.messenger_version_control.middleware.version_checker_middleware
+```