Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

Commit 0671aab

Browse files
Splaktarjelbourn
authored andcommitted
docs: clarify that this project aligns with the MD spec from 2014-2017 (#11463)
clearly reference that the Angular Material project is that place - to find an implementation of the new MD spec fix extra space in version string add Gitter and NPM badges to readme Relates to #11415. Relates to #11420.
1 parent bc8d29f commit 0671aab

File tree

2 files changed

+43
-12
lines changed

2 files changed

+43
-12
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
1-
# Material Design for AngularJS Apps [![Build Status](https://travis-ci.org/angular/material.svg)](https://travis-ci.org/angular/material)
1+
# Material Design for AngularJS Apps
2+
[![npm version](https://badge.fury.io/js/angular-material.svg)](https://www.npmjs.com/package/angular-material)
3+
[![Build Status](https://travis-ci.org/angular/material.svg)](https://travis-ci.org/angular/material)
4+
[![Gitter](https://badges.gitter.im/angular/material2.svg)](https://gitter.im/angular/material?utm_source=badge&utm_medium=badge)
25

36
[Material Design](https://material.io/archive/guidelines/) is a specification for a
47
unified system of visual, motion, and interaction design that adapts across different devices. Our
58
goal is to deliver a lean, lightweight set of AngularJS-native UI elements that implement the
69
material design specification for use in AngularJS single-page applications (SPAs).
710

11+
**AngularJS Material** is an implementation of Google's
12+
[Material Design Specification (2014-2017)](https://material.io/archive/guidelines/material-design/)
13+
for [AngularJS](https://angularjs.org) developers.
14+
15+
For an implementation of the [Material Design Specification (2018+)](https://material.io/design/),
16+
please see the [Angular Material](https://github.com/angular/material2) project which is built for
17+
[Angular](https://angular.io) developers.
18+
819
![venn diagram](https://cloud.githubusercontent.com/assets/210413/5077572/30dfc2f0-6e6a-11e4-9723-07c918128f4f.png)
920

10-
AngularJS Material is an implementation of Google's [Material Design Specification](https://material.io/archive/guidelines/material-design/).
1121
AngularJS Material includes a rich set of reusable, well-tested, and accessible UI components.
1222

1323
Quick Links:
@@ -203,4 +213,3 @@ Once you have all the necessary assets installed, add `ngMaterial` and `ngMessag
203213
```javascript
204214
angular.module('myApp', ['ngMaterial', 'ngMessages']);
205215
```
206-

docs/app/partials/home.tmpl.html

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
<md-content>
33
<h2 class="md-headline" style="margin-top: 0;">What is AngularJS Material?</h2>
44
<p>
5-
AngularJS Material is both a UI Component framework and a reference implementation of Google's
6-
<a href="https://material.io/archive/guidelines/" target="_blank" rel="noopener">Material Design Specification</a>.
7-
This project provides a set of reusable, well-tested, and accessible UI components based on Material Design.
5+
AngularJS Material is an implementation of Google's
6+
<a href="https://material.io/archive/guidelines/" target="_blank" rel="noopener">
7+
Material Design Specification (2014-2017)</a>.
8+
This project provides a set of reusable, well-tested, and accessible UI components for
9+
<a href="https://angularjs.org" target="_blank" rel="noopener">AngularJS</a> developers.
810
</p>
911
<ul class="buckets" layout layout-align="center center" layout-wrap>
1012
<li flex="50" flex-gt-md="25" ng-repeat="(index, link) in [
@@ -24,19 +26,39 @@ <h2 class="md-headline" style="margin-top: 0;">What is AngularJS Material?</h2>
2426
</li>
2527
</ul>
2628

27-
<br/>
2829
<h2 class="md-headline">AngularJS versus Angular?</h2>
2930
<p>
3031
The AngularJS Material library is a mature and stable product that is ready for production use.
3132
Developers should note that AngularJS Material works only with
3233
<a href="https://angularjs.org/" target="_blank" rel="noopener">AngularJS 1.x</a>.
3334
</p>
3435
<ul>
35-
<li>Current AngularJS Material development efforts are focused on bug fixes, accessibility, and minor improvements.</li>
36-
<li>The Angular Material library (for Angular v2+) can be found in the
37-
<a href="https://github.com/angular/material2">angular/material2</a> GitHub repository.
36+
<li>
37+
Current AngularJS Material development efforts are focused on bug fixes, accessibility, and
38+
minor improvements.
39+
</li>
40+
<li>
41+
The Angular Material library (for Angular v2+) can be found in the
42+
<a href="https://github.com/angular/material2" target="_blank" rel="noopener">angular/material2</a>
43+
GitHub repository.
3844
</li>
3945
</ul>
46+
47+
<br/>
48+
<h2 class="md-headline">The Latest Material Design</h2>
49+
<p>
50+
The latest update to Material Design
51+
(<a href="https://www.youtube.com/playlist?list=PLJ21zHI2TNh-rX-Xr_xi9KIEcbdee_1Ah" target="_blank" rel="noopener">video playlist</a>)
52+
was announced at Google I/O in May, 2018
53+
(<a href="https://design.google/library/io-2018-our-definitive-guide-design/" target="_blank" rel="noopener">recap blog post</a>).
54+
For an implementation of this new
55+
<a href="https://material.io/design" target="_blank" rel="noopener">Material Design Specification</a>,
56+
please see the <a href="https://github.com/angular/material2" target="_blank" rel="noopener">Angular Material</a>
57+
project which is built for <a href="https://angular.io" target="_blank" rel="noopener">Angular</a>
58+
developers.
59+
</p>
60+
61+
<h2 class="md-headline">Change Log</h2>
4062
<p>
4163
Please refer to our changelog for up-to-date listings of all v1.x improvements and breaking changes.
4264
</p>
@@ -227,8 +249,8 @@ <h2 class="md-headline">Google's Material Design</h2>
227249
<br/>
228250
<p class="md-caption" style="text-align: center; margin-bottom: 0;">
229251
These docs were generated from
230-
(<a ng-href="{{BUILDCONFIG.repository}}/{{menu.version.current.github}}" target="_blank" class="md-accent" >
231-
v{{BUILDCONFIG.version}} - SHA {{BUILDCONFIG.commit.substring(0,7)}}</a>)
252+
(<a ng-href="{{BUILDCONFIG.repository}}/{{menu.version.current.github}}" target="_blank"
253+
rel="noopener" class="md-accent">v{{BUILDCONFIG.version}} - SHA {{BUILDCONFIG.commit.substring(0,7)}}</a>)
232254
on (<strong>{{BUILDCONFIG.date}}</strong>) GMT.
233255
</p>
234256
</md-content>

0 commit comments

Comments
 (0)