diff --git a/README.md b/README.md index 86ea7e8d26..0aca3c91c0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,28 @@ -# Setup -1. `sudo npm install -g harp` -2. cd into root directory +# Angular.io +Angular.io is currently the preview site for Angular 2. This site also includes links to other helpful angular resources including Angular 1.X, Angular Material, and AngularFire. + +## How you can help +- [File an issue on github](https://github.com/angular/angular.io/issues) +- [Contribute to Angular.io](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md) + + +## Development Setup +1. Install Harp `sudo npm install -g harp` +2. cd into root directory `angular.io/` 3. run `harp server` -4. open [http://localhost:9000/](http://localhost:9000/) \ No newline at end of file +4. Open this url in the browser: [http://localhost:9000/](http://localhost:9000/) + + +## Technology Used +- Angular 1.x: The production ready version of Angular +- Angular Material: An implementation of Material Design in Angular.js +- Harp: The static web server with built-in preprocessing. +- Sass: A professional grade CSS extension language +- Normalize: A modern, HTML5-ready alternative to CSS resets +- Grids: A highly customizable CSS Grid Framework built with Sass +- Prettify: A JS module and CSS for syntax highlighting of source code snippets. +- Icomoon: Custom built icon fonts + + +## License +Powered by Google ©2010-2015. Code licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/). \ No newline at end of file