doc: update documents

Author: comUserDummy

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [unreleased]
+## [0.4.0] - 2024-04-23
 
 ### Features
 

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "bevy-input-sequence"
 description = "Recognizes input sequences and send events"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2021"
 authors = ["elm", "Shane Celis <shane.celis@gmail.com>"]
 keywords = [

README.md

@@ -132,6 +132,50 @@ fn check_events(mut events: EventReader<MyEvent>) {
 }
 ```
 
+## KeySequence creation patterns
+
+`KeySequence::new` now returns an implementing of `Command` instead of itself.
+Therefore, you need to call `Commands::add` instead of `Commands::spawn`.
+
+```rust
+use bevy::prelude::*;
+use bevy_input_sequence::prelude::*;
+
+#[derive(Event, Clone)]
+struct MyEvent;
+
+fn create_key_sequence(mut commands: Commands) {
+    commands.add(KeySequence::new(
+        action::send_event(bevy::app::AppExit), 
+        keyseq! { ctrl-E L M }
+    ));
+}
+
+fn create_key_sequence_and_add_it_to_an_entity(mut commands: Commands) {
+    let parent = commands.spawn_empty().id();
+    commands.entity(parent).add(KeySequence::new(
+        action::send_event(MyEvent), 
+        keyseq! { ctrl-E L M }
+    ));
+    // OR
+    commands.spawn_empty().add(KeySequence::new(
+        action::send_event(MyEvent), 
+        keyseq! { ctrl-E L M }
+    ));
+}
+
+fn create_key_sequence_within_command(mut commands: Commands) {
+    commands.add(|world: &mut World| {
+        let builder = KeySequence::new(
+            action::send_event(MyEvent), 
+            keyseq! { ctrl-E L M }
+        );
+        let key_sequence = builder.build(world);
+        // And then put it somewhere?
+    });
+}
+```
+
 # Runnable Examples
 
 ## keycode

src/lib.rs

@@ -1,7 +1,16 @@
-#![doc(html_root_url = "https://docs.rs/bevy-input-sequence/0.3.0")]
+#![doc(html_root_url = "https://docs.rs/bevy-input-sequence/0.4.0")]
 #![doc = include_str!("../README.md")]
 #![forbid(missing_docs)]
 
+pub use keyseq::{
+    bevy::{pkey as key, pkeyseq as keyseq},
+    Modifiers,
+};
+
+pub use chord::KeyChord;
+pub use plugin::InputSequencePlugin;
+pub use time_limit::TimeLimit;
+
 pub mod action;
 mod cache;
 mod chord;
@@ -12,21 +21,13 @@ pub mod input_sequence;
 mod plugin;
 mod time_limit;
 
-pub use keyseq::{
-    bevy::{pkey as key, pkeyseq as keyseq},
-    Modifiers,
-};
-
 /// Convenient splat import
 pub mod prelude {
-    pub use super::{action, keyseq, InputSequencePlugin, Modifiers, TimeLimit};
+    pub use std::time::Duration;
+
     pub use crate::input_sequence::{ButtonSequence, InputSequence, KeySequence};
 
+    pub use super::{action, InputSequencePlugin, keyseq, Modifiers, TimeLimit};
     pub use super::cond_system::IntoCondSystem;
-    pub use std::time::Duration;
 }
 
-pub use time_limit::TimeLimit;
-
-pub use chord::KeyChord;
-pub use plugin::InputSequencePlugin;