From c5bd3f0773788a9d83aae2880acf5af851e3fea4 Mon Sep 17 00:00:00 2001 From: Alex Eagle Date: Thu, 7 May 2015 16:53:58 -0700 Subject: [PATCH] Update README.md Don't tell people to build angular from source themselves. Our examples are not well-constructed for users to try them out. Closes #1756 --- README.md | 28 +++++----------------------- 1 file changed, 5 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index b0b3dccd1a..11c1dd474b 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,15 @@ Angular [![Build Status](https://travis-ci.org/angular/angular.svg?branch=master Angular is a development platform for building mobile and desktop web applications. This is the repository for [Angular 2][ng2], both the JavaScript (JS) and [Dart][dart] versions. -Angular 2 is currently in **Alpha Preview**. We recommend using Angular 1.X for production +Angular 2 is currently in **Developer Preview**. We recommend using Angular 1.X for production applications: * [AngularJS][ngJS]: [angular/angular.js](http://github.com/angular/angular.js). * [AngularDart][ngDart]: [angular/angular.dart](http://github.com/angular/angular.dart). +## Quickstart + +[Get started in 5 minutes][quickstart] ## Setup & Install Angular 2 @@ -22,32 +25,11 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! R guidelines for [contributing][contributing]. -## Examples - -To see the examples, first build the project as described -[here](http://github.com/angular/angular/blob/master/DEVELOPER.md). - -### 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/index.js`. - -You can build this example as either a JS or a Dart app: - -* JS: - * `$(npm bin)/gulp build.js.dev`, and - * `$(npm bin)/gulp serve.js.dev`, and - * open `localhost:8000/examples/src/hello_world/` in Chrome. -* Dart: - * `$(npm bin)/gulp serve/examples.dart`, and - * open `localhost:8080/src/hello_world` in Chrome (for dart2js) or - [Dartium][dartium] (for Dart VM). - [contributing]: http://github.com/angular/angular/blob/master/CONTRIBUTING.md [dart]: http://www.dartlang.org [dartium]: http://www.dartlang.org/tools/dartium [download]: http://angular.io/download +[quickstart]: https://angular.io/docs/js/latest/quickstart.html [ng2]: http://angular.io [ngDart]: http://angulardart.org [ngJS]: http://angularjs.org