add minimal example

Author: rhysd

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "keybinds"
-version = "0.0.3"
+version = "0.0.4"
 edition = "2021"
 authors = ["rhysd <[email protected]>"]
 description = "Platform&Framework-agnostic key bindings parser and dispatcher"
@@ -17,6 +17,9 @@ include = [
     "/README.md",
 ]
 
+[[example]]
+name = "minimal"
+
 [[example]]
 name = "serde"
 required-features = ["serde"]

Cargo.toml

@@ -10,8 +10,8 @@ library can be buggy and have arbitrary breaking changes.**
 
 - Provide a syntax to easily define key bindings in a configuration file like `Ctrl+a`
 - Support key sequences like `Ctrl+x Ctrl+s`
-- Support to parse/generate the key bindings configuration using [serde][] optionally ([example](./examples/serde))
-- Core API independent from any platforms and frameworks with minimal dependencies
+- Support to parse/generate the key bindings configuration using [serde][] optionally ([example](./examples/serde.rs))
+- Core API independent from any platforms and frameworks with minimal dependencies ([example](./examples/minimal.rs))
 - Support several platforms and frameworks as optional features
   - [crossterm][] ([example](./examples/crossterm.rs))
   - [termwiz][] ([example](./examples/termwiz.rs))
@@ -109,11 +109,6 @@ Here are some examples of key sequences:
 - `h e l l o`
 - `Ctrl+x Ctrl+c`
 
-## [serde][] support
-
-See the document for `serde` module.
-The serde support requires the `serde` feature enabled.
-
 ## License
 
 This crate is licensed under [the MIT license](./LICENSE.txt).

README.md

@@ -0,0 +1,39 @@
+use keybinds::{Key, KeyInput, KeybindDispatcher};
+use std::io::{self, Read};
+
+// Actions dispatched by key bindings
+#[derive(Debug)]
+enum Action {
+    SayHello,
+    ExitApp,
+}
+
+fn main() -> io::Result<()> {
+    // Create a dispatcher to dispatch actions for upcoming key inputs
+    let mut dispatcher = KeybindDispatcher::default();
+
+    // Register key bindings to dispatch the actions
+    dispatcher.bind("h e l l o", Action::SayHello).unwrap();
+    dispatcher.bind("Esc", Action::ExitApp).unwrap();
+
+    println!("Type inputs and send it by hitting Enter key. Send Esc to exit");
+    for b in io::stdin().bytes() {
+        // Convert your key input into `KeyInput` struct
+        let input = match b? {
+            b'\x1b' => KeyInput::from(Key::Esc),
+            b => KeyInput::from(b as char),
+        };
+        println!("Key input: {input:?}");
+
+        // Try to dispatch action by `dispatch` method
+        if let Some(action) = dispatcher.dispatch(input) {
+            println!("Dispatched action: {action:?}");
+            match action {
+                Action::SayHello => println!("Hello!"),
+                Action::ExitApp => break,
+            }
+        }
+    }
+
+    Ok(())
+}