Skip to content

Commit c7538b4

Browse files
jakesgordonjakesgordon
committed
more readme
1 parent d5a00dd commit c7538b4

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,10 @@ This example will create an object with 2 event methods:
7373
The `rest` event will always transition to the `hungry` state, while the `eat` event
7474
will transition to a state that is dependent on the current state.
7575

76-
>> NOTE: The `rest` event could use a wildcard '*' for the 'from' state if it should be
76+
> NOTE: The `rest` event could use a wildcard '*' for the 'from' state if it should be
7777
allowed from any current state.
7878

79-
>> NOTE: The `rest` event in the above example can also be specified as multiple events with
79+
> NOTE: The `rest` event in the above example can also be specified as multiple events with
8080
the same name if you prefer the verbose approach.
8181

8282
# Callbacks
@@ -88,7 +88,7 @@ the same name if you prefer the verbose approach.
8888
* `onenterSTATE` - fired when entering the new state
8989
* `onafterEVENT` - fired after the event
9090

91-
>> (using your **specific** EVENT and STATE names)
91+
> (using your **specific** EVENT and STATE names)
9292
9393
For convenience, the 2 most useful callbacks can be shortened:
9494

@@ -142,7 +142,7 @@ Additionally, they can be added and removed from the state machine at any time:
142142

143143
The order in which callbacks occur is as follows:
144144

145-
>> assume event **go** transitions from **red** state to **green**
145+
> assume event **go** transitions from **red** state to **green**
146146
147147
* `onbeforego` - specific handler for the **go** event only
148148
* `onbeforeevent` - generic handler for all events
@@ -153,7 +153,7 @@ The order in which callbacks occur is as follows:
153153
* `onaftergo` - specific handler for the **go** event only
154154
* `onafterevent` - generic handler for all events
155155

156-
>> NOTE: the legacy `onchangestate` handler has been deprecated and will be removed in a future version
156+
> NOTE: the legacy `onchangestate` handler has been deprecated and will be removed in a future version
157157
158158
You can affect the event in 3 ways:
159159

@@ -207,7 +207,7 @@ For example, using jQuery effects:
207207
}
208208
});
209209

210-
>> _NOTE: If you decide to cancel the ASYNC event, you can call `fsm.transition.cancel();`
210+
> NOTE: If you decide to cancel the ASYNC event, you can call `fsm.transition.cancel();`
211211
212212
# State Machine Classes
213213

@@ -242,8 +242,8 @@ instances:
242242

243243
This should be easy to adjust to fit your appropriate mechanism for object construction.
244244

245-
>> _NOTE: the `startup` event can be given any name, but it must be present in some form to
246-
ensure that each instance constructed is initialized with its own unique `current` state._
245+
> NOTE: the `startup` event can be given any name, but it must be present in some form to
246+
ensure that each instance constructed is initialized with its own unique `current` state.
247247

248248
# Initialization Options
249249

@@ -302,11 +302,11 @@ same as the first example in this section where you simply define your own start
302302

303303
So you have a number of choices available to you when initializing your state machine.
304304

305-
>> _IMPORTANT NOTE: if you are using the pattern described in the previous section "State Machine
306-
Classes", and wish to declare an `initial` state in this manner, you MUST use the `defer: true`
307-
attribute and manually call the starting event in your constructor function. This will ensure
308-
that each instance gets its own unique `current` state, rather than an (unwanted) shared
309-
`current` state on the prototype object itself._
305+
> IMPORTANT NOTE: if you are using the pattern described in the previous section "State Machine
306+
Classes", and wish to declare an `initial` state in this manner, you MUST use the `defer: true`
307+
attribute and manually call the starting event in your constructor function. This will ensure
308+
that each instance gets its own unique `current` state, rather than an (unwanted) shared
309+
`current` state on the prototype object itself.
310310

311311
# Handling Failures
312312

@@ -344,12 +344,12 @@ define a custom `error` handler:
344344

345345
* You can find the [code on github](https://github.com/jakesgordon/javascript-state-machine)
346346
* You can find a [working demo here](http://codeincomplete.com/posts/2011/8/19/javascript_state_machine_v2/example/)
347-
* [v2.3 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v2-3-0/) - 3/15/2014
348-
* [v2.2 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v2-2-0/) - 1/26/2013
349-
* [v2.1 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v2-1-0/) - 1/7/2012
350-
* [v2.0 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v2) - 8/19/2011
351-
* [v1.2 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v1-2-0) - 6/21/2011
352-
* [v1.0 release announcement](http://codeincomplete.com/posts/javascript-state-machine) - 6/1/2011
347+
* [v2.3 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v2-3-0/)
348+
* [v2.2 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v2-2-0/)
349+
* [v2.1 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v2-1-0/)
350+
* [v2.0 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v2)
351+
* [v1.2 release announcement](http://codeincomplete.com/posts/javascript-state-machine-v1-2-0)
352+
* [v1.0 release announcement](http://codeincomplete.com/posts/javascript-state-machine)
353353

354354
# Release Notes
355355

0 commit comments

Comments
 (0)