Skip to content

Commit 6fd16bf

Browse files
author
Lawson Kurtz
committed
Add READMEs for all examples, fix a bug w/ react-router example
1 parent 0267b12 commit 6fd16bf

File tree

7 files changed

+55
-6
lines changed

7 files changed

+55
-6
lines changed

examples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ states.
2020

2121
A simple drawing application. Click tiles across a grid to flip them
2222
between black and white. This example was created to test the
23-
time-travel debugger for Microcosm.
23+
[time-travel debugger for Microcosm](https://github.com/vigetlabs/microcosm-debugger).
2424

2525
### ReactRouter
2626

examples/chatbot/README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Chatbot Example
22

3-
A chat application where users interact with an Elizabot chat program.
3+
A messaging client that interacts with a chat bot. This example
4+
demonstrates optimistic updates, asynchronous requests, and loading
5+
states.
46

57
## Setup
68

79
```
810
npm install
9-
npm start
11+
make start
12+
open http://localhost:4000
1013
```
1114

1215
## How it works
@@ -25,9 +28,9 @@ const Messages = {
2528
// ..
2629
register() {
2730
return {
28-
[sendChat.open] : Messages.addLoading,
29-
[sendChat.done] : Messages.add,
30-
[sendChat.failed] : Messages.addError
31+
[send.open] : Messages.addLoading,
32+
[send.done] : Messages.add,
33+
[send.failed] : Messages.addError
3134
}
3235
}
3336
}

examples/painter/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Painter Example
2+
3+
A simple drawing application. Click tiles across a grid to flip them
4+
between black and white. This example was created to test the
5+
[time-travel debugger for Microcosm](https://github.com/vigetlabs/microcosm-debugger).
6+
7+
A pixel-painting application to showcase some of Microcosm's capabilities around
8+
action history using [microcosm-debugger](https://github.com/vigetlabs/microcosm-debugger).
9+
10+
## Setup
11+
12+
```
13+
npm install
14+
make start
15+
open http://localhost:4000
16+
```

examples/react-router/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# React Router Example
2+
3+
A simple Todo app demonstrating the use of Microcosm with React Router.
4+
5+
## Setup
6+
7+
```
8+
npm install
9+
make start
10+
open http://localhost:4000
11+
```

examples/react-router/app/routes.js

Whitespace-only changes.

examples/simple-svg/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# SVG Animation Example
2+
3+
An animated SVG example that uses actions to animate the orbiting of
4+
one circle around another. Demonstrates the thunk usage pattern for
5+
actions.
6+
7+
## Setup
8+
9+
```
10+
npm install
11+
make start
12+
open http://localhost:4000
13+
```

package.json

+6
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@
5252
"babel-cli": "6.11.4",
5353
"babel-core": "6.11.4",
5454
"babel-loader": "6.2.4",
55+
"babel-plugin-transform-es2015-classes": "6.9.0",
56+
"babel-plugin-transform-es2015-computed-properties": "6.8.0",
57+
"babel-plugin-transform-es2015-destructuring": "6.9.0",
58+
"babel-plugin-transform-es2015-for-of": "6.8.0",
59+
"babel-plugin-transform-es2015-modules-commonjs": "6.11.5",
60+
"babel-plugin-transform-es2015-typeof-symbol": "6.8.0",
5561
"babel-preset-es2015": "6.9.0",
5662
"babel-preset-react": "6.11.1",
5763
"babel-preset-stage-2": "6.11.0",

0 commit comments

Comments
 (0)