Skip to content

Commit ddea481

Browse files
committed
tweaks to readme
1 parent a369986 commit ddea481

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ This standalone javascript micro-framework provides a finite state machine for y
1010
Download
1111
========
1212

13-
You can download the [source state-machine.js here](https://github.com/jakesgordon/javascript-state-machine/raw/master/state-machine.js),
14-
or the [minified version here](https://github.com/jakesgordon/javascript-state-machine/raw/master/state-machine.min.js)
13+
You can download [state-machine.js](https://github.com/jakesgordon/javascript-state-machine/raw/master/state-machine.js),
14+
or the [minified version](https://github.com/jakesgordon/javascript-state-machine/raw/master/state-machine.min.js)
1515

16-
Alternatively
16+
Alternatively:
1717

1818
git clone git@github.com:jakesgordon/javascript-state-machine
1919

2020

2121
* All code is in state-machine.js
22-
* Minified version provided as state-machine.min.js
22+
* Minified version provided in state-machine.min.js
2323
* No 3rd party library is required
2424
* Demo can be found in /index.html
2525
* QUnit tests can be found in /test/index.html
@@ -71,7 +71,7 @@ If an event should be available from multiple states, simply use an array in the
7171
Hooks
7272
=====
7373

74-
4 hooks are available if FSM has methods using the following naming conventions:
74+
4 hooks are available if your object has methods using the following naming conventions:
7575

7676
* onbefore**event** - fired before an event
7777
* onafter**event** - fired after an event
@@ -80,10 +80,10 @@ Hooks
8080

8181
The order of the hooks should be as expected:
8282

83-
* onbefore**event** - fired before an event
84-
* onleave**state** - fired when leaving existing state
85-
* onenter**state** - fired when entering new state
86-
* onafter**event** - fired after event
83+
* onbefore**event**
84+
* onleave**state**
85+
* onenter**state**
86+
* onafter**event**
8787

8888
For convenience, the 2 most useful hooks can be shortened:
8989

@@ -142,7 +142,7 @@ In this way, you can also turn all instances of a _class_ into an FSM by applyi
142142
the state machine functionality in a constructor function, and adding your hooks
143143
into the prototype:
144144

145-
MyFSM = function() {
145+
MyFSM = function() { // my constructor function
146146
StateMachine.create({
147147
target: this,
148148
state: 'green',

0 commit comments

Comments
 (0)