Finite state machines in rust; bendns fork to add types.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8d44c06..e4a728b 100644
--- a/README.md
+++ b/README.md
@@ -70,6 +70,7 @@ use rust_fsm::*;
state_machine! {
#[derive(Debug)]
#[repr(C)]
+ /// A Circuit Breaker state machine.
circuit_breaker(Closed)
Closed(Unsuccessful) => Open [SetupTimer],
@@ -198,6 +199,12 @@ controlled by the `diagram` feature, which is non-default. The diagrams are
generated in the [Mermaid][mermaid] format. This feature includes the Mermaid
script into the documentation page.
+To see this in action, download the repository and run:
+
+```bash
+cargo doc -p doc-example --open
+```
+
### Without DSL
The `state_machine` macro has limited capabilities (for example, a state