From 03e2c94c6cc5bcba1c9d381b590fff78c85d61db Mon Sep 17 00:00:00 2001 From: Rado Kirov Date: Fri, 21 Nov 2014 15:17:00 -0800 Subject: [PATCH] doc(readme): adds examples to readme. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index d2bd8411df..327fe843b3 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,19 @@ Restriction for Dart tests (for now): `package:` dependencies (created e.g. for `import ... from 'di:di'`). So you need to execute `gulp build` before this. +### Examples: + +To see the examples, first build the project as described above. + +#### Hello World Example +This example consists of three basic pieces - a component, a decorator and a service. +They are all constructed via injection. For more information see the comments in the +source `modules/examples/src/hello_world/app.js`. + +You can build this example as either JS or Dart app: +* (JS) `gulp serve` and open `localhost:8000/js/examples/lib/hello_world/` in Chrome. +* (Dart) `gulp examples/pub.serve` and open `localhost:8080` in Chrome(for dart2js) or dartium(for dart vm). + ## Debug the transpiler If you need to debug the transpiler: