Skip to content
This repository was archived by the owner on Apr 17, 2020. It is now read-only.

Commit 7941b08

Browse files
committed
Update README
1 parent e93f748 commit 7941b08

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# react-xstate-js
2-
A React interpreter for [xstate](https://github.com/davidkpiano/xstate) that uses renderProps.
2+
A React interpreter for [XState](https://github.com/davidkpiano/xstate) that uses renderProps.
33

44
# Installation
55
```bash
@@ -606,7 +606,7 @@ A [React](https://reactjs.org/) interpreter for [xstate](https://github.com/davi
606606
### Props
607607
#### config: xstate [machine config](https://xstate.js.org/api/interfaces/machineconfig.html).
608608
```js
609-
const mmyMachineConfig = {
609+
const myMachineConfig = {
610610
key: 'example1',
611611
initial: 'step1',
612612
states: {
@@ -643,7 +643,7 @@ const myMachineOptions = {
643643

644644
#### savedState: xstate [State](https://xstate.js.org/api/classes/state.html).
645645
```js
646-
const savedState = {
646+
const mySavedState = {
647647
"actions": [],
648648
"activities": {},
649649
"meta": {},
@@ -687,6 +687,13 @@ const savedState = {
687687
};
688688
```
689689

690+
#### savedContext: any.
691+
```js
692+
const mySavedContext = {
693+
myKeg: 'myValue'
694+
}
695+
```
696+
690697
### Return
691698
#### service: xstate [interpreter](https://xstate.js.org/docs/guides/interpretation.html).
692699
```jsx

0 commit comments

Comments
 (0)