Skip to content

Commit

Permalink
docs: Fix formatting and wording issues
Browse files Browse the repository at this point in the history
  • Loading branch information
johanhelsing committed Dec 12, 2024
1 parent ffab55e commit d6c6ff5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
11 changes: 7 additions & 4 deletions bevy_matchbox/examples/hello_host.rs
Original file line number Diff line number Diff line change
@@ -1,10 +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 ensure your project cargo.toml file has been updated with
//! the appropriate dependencies. When building a signaling server, enable the `signaling` feature:
//! ```toml bevy_matchbox = { version = "0.n", features = ["signaling"] }```
//!
//! 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,
Expand Down
11 changes: 7 additions & 4 deletions bevy_matchbox/examples/hello_signaling.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
//! Runs a signaling server with server/client topology as a headless bevy
//! application.
//!
//! Note: When building a signaling server ensure your project cargo.toml file has been updated with
//! the appropriate dependencies. When building a signaling server, enable the `signaling` feature:
//! ```toml bevy_matchbox = { version = "0.n", features = ["signaling"] }```
//!
//! 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::*};
Expand Down

0 comments on commit d6c6ff5

Please sign in to comment.