Skip to content

Commit 270c711

Browse files
author
Tom Saporito
committed
updates readme with new demo
1 parent e82ee54 commit 270c711

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ const newState = {
179179

180180
## Demo
181181

182-
https://codesandbox.io/embed/todo-with-undo-vgvl0?autoresize=1&fontsize=14
182+
https://codesandbox.io/s/substate-example-6qfbx
183183

184184
## Installation
185185

@@ -261,13 +261,13 @@ These are the possible options
261261
- `@param` optional method parameter
262262
- `@param*` required method parameter
263263

264-
| Method | Desc | Returns |
265-
| --------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------: |
266-
| getState | get a state `@param*` - index of state needed | state |
267-
| getCurrentState | get the current state | current state object |
268-
| getProp | get a prop from current state `@param*` - string path to prop | property you request |
269-
| changeState (WIP) | change the version of the state `@param*` - `{requestedState: index of state, action: (optional name of event to emit)}` | emits `action` parameter event or 'STATE_CHANGED' event with the new current state |
270-
| resetState | resets the `stateStorage` array to an empty array | emits 'STATE_RESET' |
264+
| Method | Desc | Returns |
265+
| ----------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------: |
266+
| getState | get a state `@param*` - index of state needed | state |
267+
| getCurrentState | get the current state | current state object |
268+
| getProp | get a prop from current state `@param*` - string path to prop | property you request |
269+
| changeState (WIP) | change the version of the state `@param*` - `{requestedState: index of state, action: (optional name of event to emit)}` | emits `action` parameter event or 'STATE_CHANGED' event with the new current state |
270+
| resetState | resets the `stateStorage` array to an empty array | emits 'STATE_RESET' |
271271

272272
## Event Methods
273273

0 commit comments

Comments
 (0)