updated docs

TinyStuff · Nov 1, 2021 · 0a842f2 · 0a842f2
1 parent 37986b9
commit 0a842f2
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,14 @@
 ## Build status
 <img src="https://io2gamelabs.visualstudio.com/_apis/public/build/definitions/be16d002-5786-41a1-bf3b-3e13d5e80aa0/8/badge" alt="Build Status" />
 
+## 3.0 Breaking changes
+* **TinyNavigationHelper** is merged into TinyMvvm and the namespaced is changed to **TinyMvvm**.
+* To use ViewModel navigation with shell you have to call **InitViewModelNavigation**.
+
+```csharp
+navigationHelper.InitViewModelNavigation(viewModelAssembly);
+```
+
 ## What is TinyMvvm?
 TinyMvvm is a MVVM library that is built for Xamarin.Forms but is not limited to Xamarin.Forms, it created in a way that it will be easy to extend to other platforms.