Skip to content

Commit 2209308

Browse files
devversionjelbourn
authored andcommitted
docs: add section for installation to readme (#2347)
* Adds a simple section for installation to the readme.
1 parent 1927814 commit 2209308

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,32 @@ This is the home for the Angular team's Material Design components built on top
1010
[Contributing](https://github.com/angular/material2/blob/master/CONTRIBUTING.md),
1111
[Plunker Template](http://plnkr.co/edit/o077B6uEiiIgkC0S06dd?p=preview)
1212

13-
### Getting started
13+
### Installation
14+
15+
The latest release of Angular Material can be installed from npm
16+
17+
`npm install @angular/material`
18+
19+
Playing with the latest changes from [master](https://github.com/angular/material2/tree/master) is also possible
20+
21+
`npm install https://github.com/angular/material2-builds.git`
22+
23+
### Getting started
1424

1525
See our [Getting Started Guide](https://github.com/angular/material2/blob/master/GETTING_STARTED.md)
1626
if you're building your first project with Angular Material 2.
1727

1828
### Project status
19-
Angular Material 2 is currently in alpha and under active development.
29+
Angular Material 2 is currently in alpha and under active development.
2030
During alpha, breaking API and behavior changes will be occurring regularly.
2131

22-
Check out our [directory of design documents](https://github.com/angular/material2/wiki/Design-doc-directory)
32+
Check out our [directory of design documents](https://github.com/angular/material2/wiki/Design-doc-directory)
2333
for more insight into our process.
2434

25-
If you'd like to contribute, you must follow our [contributing guidelines](https://github.com/angular/material2/blob/master/CONTRIBUTING.md).
26-
You can look through the issues (which should be up-to-date on who is working on which features
27-
and which pieces are blocked) and make a comment.
28-
Also see our [`Good for community contribution`](https://github.com/angular/material2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+for+community+contribution%22)
35+
If you'd like to contribute, you must follow our [contributing guidelines](https://github.com/angular/material2/blob/master/CONTRIBUTING.md).
36+
You can look through the issues (which should be up-to-date on who is working on which features
37+
and which pieces are blocked) and make a comment.
38+
Also see our [`Good for community contribution`](https://github.com/angular/material2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+for+community+contribution%22)
2939
label.
3040

3141
High level items planned for December 2016:
@@ -36,7 +46,7 @@ High level items planned for December 2016:
3646
* Continued expanding e2e test coverage
3747
* Paginated tabs.
3848
* Scroll / resize handling for overlays
39-
* Production build
49+
* Production build
4050
* AoT compile e2e app
4151
* Release beta.0
4252

@@ -131,8 +141,8 @@ High level items planned for December 2016:
131141
be missing some behaviors or polish.
132142

133143
## The goal of Angular Material
134-
Our goal is to build a set of high-quality UI components built with Angular 2 and TypeScript,
135-
following the Material Design spec. These
144+
Our goal is to build a set of high-quality UI components built with Angular 2 and TypeScript,
145+
following the Material Design spec. These
136146
components will serve as an example of how to write Angular code following best practices.
137147

138148
### What do we mean by "high-quality"?
@@ -145,7 +155,7 @@ components will serve as an example of how to write Angular code following best
145155
* Code is clean and well-documented to serve as an example for Angular devs.
146156

147157
## Browser and screen reader support
148-
Angular Material supports the most recent two versions of all major browsers:
158+
Angular Material supports the most recent two versions of all major browsers:
149159
Chrome (including Android), Firefox, Safari (including iOS), and IE11 / Edge
150160

151161
We also aim for great user experience with the following screen readers:

0 commit comments

Comments
 (0)