From 2c952f96614758429931ba178fbeaac56fbb1738 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=AE=D1=80=D0=B8=D0=B9=20=D0=A2=D1=83=D1=80=D0=B1=D0=B8?=
 =?UTF-8?q?=D0=BD?= <yuri.turbin@bergen.tech>
Date: Fri, 19 Jul 2024 15:18:55 +0300
Subject: [PATCH] Migration to LEGO AsyncApi.Net guid

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index d522e7c0..3caab20c 100644
--- a/README.md
+++ b/README.md
@@ -234,6 +234,24 @@ Each document can be accessed by specifying the name in the URL
 }
 ```
 
+## Migration to LEGO AsyncApi.Net
+
+When switching to the LEGO AsyncApi.Net, we broke the public API.
+
+To simplify the transition to new versions of the library, this note was created.
+
+What was broken:
+
+* Namespaces have changed:
+    * Saunter.AsyncApiSchema.v2 -> LEGO.AsyncAPI.Models
+    * Saunter.Attributes; -> Saunter.AttributeProvider.Attributes
+* Change the name of the data structures, add prefix 'AsyncApi' (example 'class Info' -> 'class AsyncApiInfo')
+* All data structure constructors are now with the parameterless constructor
+
+There was no more significant changes on public API.
+
+Keep this in mind when planning the migration process.
+
 ## Contributing
 
 See our [contributing guide](https://github.com/asyncapi/saunter/blob/main/CONTRIBUTING.md/CONTRIBUTING.md).