Update Doc and README (#40)

Co-authored-by: Pierre POLLET <[email protected]>
projectharmonia · Sep 22, 2023 · fbca347 · fbca347
1 parent 0c681da
commit fbca347
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,12 @@
 
 Write the same logic that works for both multiplayer and single-player. The crate provides synchronization of components and network events between the server and clients using the [Renet](https://github.com/lucaspoffo/renet) library for the [Bevy game engine](https://bevyengine.org).
 
-See the quick start guide by clicking on the docs badge.
+## Getting Started
+
+Check out the [quick start guide](https://docs.rs/bevy_replicon/latest/bevy_replicon).
+
+See also [Tic-Tac-Toe](https://github.com/lifescapegame/bevy_replicon/tree/master/examples/tic_tac_toe.rs) example.
+
 
 ## Bevy compatibility
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -47,8 +47,10 @@ keep the world in sync.
 
 ### Marking for replication
 
-By default, no components are replicated. To start replication, you need two
-things:
+By default, no components are replicated. A component will be replicated if it has been registered for replication
+**and** its entity has the [`Replication`] component.
+
+In other words you need two things to start replication :
 
 1. Register component type for replication. Component should implement
 [`serde::Serialize`] and [`serde::Deserialize`].