Updated README documentation to include information about serializati…

…on of navigators
chRyNaN · May 23, 2023 · 6724558 · 6724558
1 parent 0e666fa
commit 6724558
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -224,6 +224,17 @@ NavigationContainer(navigator) { destination ->
 }
 ```
 
+* Utilize [kotlinx serialization](https://github.com/Kotlin/kotlinx.serialization) and
+ the [serialization-parcelable](https://github.com/chRyNaN/serialization-parcelable) library to transfer a `Navigator`
+ between components.
+
+```kotlin
+val navigatorSerializer = Navigator.serializer(destinationSerializer, contextSerializer)
+
+parcelable.encodeToParcel(serializer = navigatorSerializer, value = navigator)
+json.encodeToString(serializer = navigatorSerializer, value = navigator)
+```
+
 ## Documentation 📃
 
 More detailed documentation is available in the [docs](docs/) folder. The entry point to the documentation can be