Note system_state example on examples/README.md page

stillonearth · Feb 17, 2023 · 294d571 · 294d571
1 parent 33e3ae3
commit 294d571
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/docs/system-state.gif b/docs/system-state.gif
diff --git a/examples/README.md b/examples/README.md
@@ -61,4 +61,14 @@ The promise-based loop works like this:
   - break loop if yes pressed --------.
 - exit app  <-------------------------`
 ```
-![Confirmation](../docs/confirmation.gif)
+![Confirmation](../docs/confirmation.gif)
+
+### `system_state`
+```bash
+cargo run --example system_state
+```
+This example shows how promises keep the state of Bevy's system params.
+We create 16 buttons and asyn loop single promise every second.
+Inside the promise we log buttons with changed for the previous second
+`Interaction` component by querying with Changed<Interaction> filter.
+![System State](../docs/system-state.gif)
diff --git a/examples/system_state.rs b/examples/system_state.rs
@@ -1,7 +1,7 @@
-//! This example shows how promises keeps the state of Bevy's system params.
-//! Here, I create 16 buttons and repeat promise every second.
-//! Inside the promise I log buttons with changed for the previous second
-//! Interaction component by applying Changed<Interaction> filter to Query.
+//! This example shows how promises keep the state of Bevy's system params.
+//! We create 16 buttons and asyn loop single promise every second.
+//! Inside the promise we log buttons with changed for the previous second
+//! `Interaction` component by querying with Changed<Interaction> filter.
 use bevy::prelude::*;
 use pecs::prelude::*;