Skip to content

Commit

Permalink
docs: clarify that this project aligns with the MD spec from 2014-2017 (
Browse files Browse the repository at this point in the history
angular#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 angular#11415. Relates to angular#11420.
  • Loading branch information
Splaktar authored and jelbourn committed Sep 27, 2018
1 parent bc8d29f commit 0671aab
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 12 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
# Material Design for AngularJS Apps [![Build Status](https://travis-ci.org/angular/material.svg)](https://travis-ci.org/angular/material)
# Material Design for AngularJS Apps
[![npm version](https://badge.fury.io/js/angular-material.svg)](https://www.npmjs.com/package/angular-material)
[![Build Status](https://travis-ci.org/angular/material.svg)](https://travis-ci.org/angular/material)
[![Gitter](https://badges.gitter.im/angular/material2.svg)](https://gitter.im/angular/material?utm_source=badge&utm_medium=badge)

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

**AngularJS Material** is an implementation of Google's
[Material Design Specification (2014-2017)](https://material.io/archive/guidelines/material-design/)
for [AngularJS](https://angularjs.org) developers.

For an implementation of the [Material Design Specification (2018+)](https://material.io/design/),
please see the [Angular Material](https://github.com/angular/material2) project which is built for
[Angular](https://angular.io) developers.

![venn diagram](https://cloud.githubusercontent.com/assets/210413/5077572/30dfc2f0-6e6a-11e4-9723-07c918128f4f.png)

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

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

40 changes: 31 additions & 9 deletions docs/app/partials/home.tmpl.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
<md-content>
<h2 class="md-headline" style="margin-top: 0;">What is AngularJS Material?</h2>
<p>
AngularJS Material is both a UI Component framework and a reference implementation of Google's
<a href="https://material.io/archive/guidelines/" target="_blank" rel="noopener">Material Design Specification</a>.
This project provides a set of reusable, well-tested, and accessible UI components based on Material Design.
AngularJS Material is an implementation of Google's
<a href="https://material.io/archive/guidelines/" target="_blank" rel="noopener">
Material Design Specification (2014-2017)</a>.
This project provides a set of reusable, well-tested, and accessible UI components for
<a href="https://angularjs.org" target="_blank" rel="noopener">AngularJS</a> developers.
</p>
<ul class="buckets" layout layout-align="center center" layout-wrap>
<li flex="50" flex-gt-md="25" ng-repeat="(index, link) in [
Expand All @@ -24,19 +26,39 @@ <h2 class="md-headline" style="margin-top: 0;">What is AngularJS Material?</h2>
</li>
</ul>

<br/>
<h2 class="md-headline">AngularJS versus Angular?</h2>
<p>
The AngularJS Material library is a mature and stable product that is ready for production use.
Developers should note that AngularJS Material works only with
<a href="https://angularjs.org/" target="_blank" rel="noopener">AngularJS 1.x</a>.
</p>
<ul>
<li>Current AngularJS Material development efforts are focused on bug fixes, accessibility, and minor improvements.</li>
<li>The Angular Material library (for Angular v2+) can be found in the
<a href="https://github.com/angular/material2">angular/material2</a> GitHub repository.
<li>
Current AngularJS Material development efforts are focused on bug fixes, accessibility, and
minor improvements.
</li>
<li>
The Angular Material library (for Angular v2+) can be found in the
<a href="https://github.com/angular/material2" target="_blank" rel="noopener">angular/material2</a>
GitHub repository.
</li>
</ul>

<br/>
<h2 class="md-headline">The Latest Material Design</h2>
<p>
The latest update to Material Design
(<a href="https://www.youtube.com/playlist?list=PLJ21zHI2TNh-rX-Xr_xi9KIEcbdee_1Ah" target="_blank" rel="noopener">video playlist</a>)
was announced at Google I/O in May, 2018
(<a href="https://design.google/library/io-2018-our-definitive-guide-design/" target="_blank" rel="noopener">recap blog post</a>).
For an implementation of this new
<a href="https://material.io/design" target="_blank" rel="noopener">Material Design Specification</a>,
please see the <a href="https://github.com/angular/material2" target="_blank" rel="noopener">Angular Material</a>
project which is built for <a href="https://angular.io" target="_blank" rel="noopener">Angular</a>
developers.
</p>

<h2 class="md-headline">Change Log</h2>
<p>
Please refer to our changelog for up-to-date listings of all v1.x improvements and breaking changes.
</p>
Expand Down Expand Up @@ -227,8 +249,8 @@ <h2 class="md-headline">Google's Material Design</h2>
<br/>
<p class="md-caption" style="text-align: center; margin-bottom: 0;">
These docs were generated from
(<a ng-href="{{BUILDCONFIG.repository}}/{{menu.version.current.github}}" target="_blank" class="md-accent" >
v{{BUILDCONFIG.version}} - SHA {{BUILDCONFIG.commit.substring(0,7)}}</a>)
(<a ng-href="{{BUILDCONFIG.repository}}/{{menu.version.current.github}}" target="_blank"
rel="noopener" class="md-accent">v{{BUILDCONFIG.version}} - SHA {{BUILDCONFIG.commit.substring(0,7)}}</a>)
on (<strong>{{BUILDCONFIG.date}}</strong>) GMT.
</p>
</md-content>
Expand Down

0 comments on commit 0671aab

Please sign in to comment.