Merge branch 'doc-signaling-feature'

johanhelsing · Dec 12, 2024 · 3a3f5c1 · 3a3f5c1
2 parents 644e74e + d6c6ff5
commit 3a3f5c1
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/bevy_matchbox/examples/hello_host.rs b/bevy_matchbox/examples/hello_host.rs
@@ -1,6 +1,13 @@
 //! Runs both signaling with server/client topology and runs the host in the same process
 //!
 //! Sends messages periodically to all connected clients.
+//!
+//! Note: When building a signaling server make sure you depend on
+//! `bevy_matchbox` with the `signaling` feature enabled.
+//!
+//! ```toml
+//! bevy_matchbox = { version = "0.x", features = ["signaling"] }
+//! ```
 
 use bevy::{
     app::ScheduleRunnerPlugin, log::LogPlugin, prelude::*, time::common_conditions::on_timer,

diff --git a/bevy_matchbox/examples/hello_signaling.rs b/bevy_matchbox/examples/hello_signaling.rs
@@ -1,5 +1,12 @@
 //! Runs a signaling server with server/client topology as a headless bevy
 //! application.
+//!
+//! Note: When building a signaling server make sure you depend on
+//! `bevy_matchbox` with the `signaling` feature enabled.
+//!
+//! ```toml
+//! bevy_matchbox = { version = "0.x", features = ["signaling"] }
+//! ```
 
 use bevy::{app::ScheduleRunnerPlugin, log::LogPlugin, prelude::*, utils::Duration};
 use bevy_matchbox::{matchbox_signaling::SignalingServer, prelude::*};