Skip to content

Commit 945ce7e

Browse files
committed
docs(readme): add examples section
1 parent bfca278 commit 945ce7e

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,10 @@ export default class App extends Component {
3434
}
3535
```
3636

37-
**You can find [more examples with live demos here](/examples).**
38-
3937
### About decorators
4038

4139
`@easyState` is a decorator, which is not yet part of the JS language. You can learn how to enable decorators with babel [here](https://github.com/loganfsmyth/babel-plugin-transform-decorators-legacy) or you can use the older `export default easyState(Comp)` syntax.
4240

43-
## Platform support
44-
45-
- Node: 6 and above
46-
- Chrome: 49 and above
47-
- Firefox: 38 and above
48-
- Safari: 10 and above
49-
- Edge: 12 and above
50-
- Opera: 36 and above
51-
- React native is not yet supported
52-
- IE is not supported
53-
5441
## Key features
5542

5643
- Your state can use any valid JavaScript. Feel free to use nested objects, arrays, expando properties, getters/setters, inheritance and ES6 collections directly.
@@ -69,6 +56,23 @@ export default class App extends Component {
6956

7057
As a result a stable and fresh state and view is always achieved before the next repaint with the minimal number of required renders.
7158

59+
## Examples with live demos
60+
61+
- [Hello World](https://solkimicreb.github.io/react-easy-state/examples/helloWorld/) ([source](/examples/helloWorld/))
62+
- [Simple Todos](https://solkimicreb.github.io/react-easy-state/examples/simpleTodos/) ([source](/examples/simpleTodos/))
63+
- [TodoMVC](https://solkimicreb.github.io/react-easy-state/examples/todoMVC/) ([source](/examples/todoMVC/))
64+
65+
## Platform support
66+
67+
- Node: 6 and above
68+
- Chrome: 49 and above
69+
- Firefox: 38 and above
70+
- Safari: 10 and above
71+
- Edge: 12 and above
72+
- Opera: 36 and above
73+
- React native is not yet supported
74+
- IE is not supported
75+
7276
## How does it work?
7377

7478
Under the hood it uses the [@nx-js/observer-util](https://github.com/nx-js/observer-util) library, which relies on ES6 Proxies to observe state changes. Thanks to the Proxies it doesn't have edge cases or limitations. You can write any JS code without worrying about the render function. [This blog post](https://blog.risingstack.com/writing-a-javascript-framework-data-binding-es6-proxy/) gives a little sneak peek under the hood of the `observer-util`.

0 commit comments

Comments
 (0)