Skip to content

Commit 03e2c94

Browse files
committed
doc(readme): adds examples to readme.
1 parent 70c38e6 commit 03e2c94

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,19 @@ Restriction for Dart tests (for now):
5252
`package:` dependencies (created e.g. for `import ... from 'di:di'`).
5353
So you need to execute `gulp build` before this.
5454

55+
### Examples:
56+
57+
To see the examples, first build the project as described above.
58+
59+
#### Hello World Example
60+
This example consists of three basic pieces - a component, a decorator and a service.
61+
They are all constructed via injection. For more information see the comments in the
62+
source `modules/examples/src/hello_world/app.js`.
63+
64+
You can build this example as either JS or Dart app:
65+
* (JS) `gulp serve` and open `localhost:8000/js/examples/lib/hello_world/` in Chrome.
66+
* (Dart) `gulp examples/pub.serve` and open `localhost:8080` in Chrome(for dart2js) or dartium(for dart vm).
67+
5568
## Debug the transpiler
5669

5770
If you need to debug the transpiler:

0 commit comments

Comments
 (0)