diff --git a/examples/README.md b/examples/README.md index a3468bcb..d24fea6b 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,12 +1,39 @@ Sample Applications =================== -Sample applications that use the Rhai scripting engine. +Standard Examples +----------------- + +| Example | Description | +| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| [`arrays_and_structs`](arrays_and_structs.rs) | shows how to register a Rust type and using it with arrays | +| [`custom_types_and_methods`](custom_types_and_methods.rs) | shows how to register a Rust type and methods/getters/setters for it | +| [`hello`](hello.rs) | simple example that evaluates an expression and prints the result | +| [`reuse_scope`](reuse_scope.rs) | evaluates two pieces of code in separate runs, but using a common `Scope` | +| [`serde`](serde.rs) | example to serialize and deserialize Rust types with [`serde`](https://crates.io/crates/serde) (requires the `serde` feature) | +| [`simple_fn`](simple_fn.rs) | shows how to register a simple Rust function | +| [`strings`](strings.rs) | shows different ways to register Rust functions taking string arguments | +| [`threading`](threading.rs) | shows how to communicate with an `Engine` running in a separate thread via an MPSC channel | -How to Run ----------- +Scriptable Event Handler With State Examples +------------------------------------------- -```bash -cargo run --example sample_app_to_run +Because of its popularity, included are sample implementations for the pattern +[_Scriptable Event Handler With State_](https://rhai.rs/book/patterns/events.md) in different styles. + +| Example | Handler Script | Description | +| ------------------------------------------ | ------------------------------------------------------------------ | :-------------------------------------------------------: | +| [`event_handler_main`](event_handler_main) | [`event_handler_main/script.rhai`](event_handler_main/script.rhai) | [_Main Style_](https://rhai.rs/book/patterns/events-1.md) | +| [`event_handler_js`](event_handler_js) | [`event_handler_js/script.rhai`](event_handler_js/script.rhai) | [_JS Style_](https://rhai.rs/book/patterns/events-2.md) | +| [`event_handler_map`](event_handler_map) | [`event_handler_map/script.rhai`](event_handler_map/script.rhai) | [_Map Style_](https://rhai.rs/book/patterns/events-3.md) | + + +Running Examples +---------------- + +Examples can be run with the following command: + +```sh +cargo run --example {example_name} ```