Skip to content

Commit 82b5679

Browse files
Splaktarjelbourn
authored andcommitted
docs(readme): general update and refresh (#15784)
add Chrome OS screen reader support add details about the CDK remove unused link definitions
1 parent 9a10f48 commit 82b5679

File tree

1 file changed

+24
-49
lines changed

1 file changed

+24
-49
lines changed

README.md

Lines changed: 24 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Material Design for Angular
1+
# Components and Material Design for Angular
22
[![npm version](https://badge.fury.io/js/%40angular%2Fmaterial.svg)](https://www.npmjs.com/package/%40angular%2Fmaterial)
33
[![Build status](https://circleci.com/gh/angular/material2.svg?style=svg)](https://circleci.com/gh/angular/material2)
44
[![Gitter](https://badges.gitter.im/angular/material2.svg)](https://gitter.im/angular/material2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
55

6-
This is the home for the Angular team's Material Design components built for and with Angular.
6+
This is the home for the Angular team's UI components built for and with Angular.
7+
These include Material Design components and the Angular Component Development Kit (CDK).
78

89
#### Quick links
910
[Documentation, demos, and guides][aio] |
1011
[Google group](https://groups.google.com/forum/#!forum/angular-material2) |
1112
[Contributing](https://github.com/angular/material2/blob/master/CONTRIBUTING.md) |
12-
[Plunker Template](https://goo.gl/uDmqyY) |
1313
[StackBlitz Template](https://goo.gl/wwnhMV)
1414

1515
### Getting started
@@ -21,10 +21,11 @@ Check out our [directory of design documents](https://github.com/angular/materia
2121
for more insight into our process.
2222

2323
If you'd like to contribute, you must follow our [contributing guidelines](https://github.com/angular/material2/blob/master/CONTRIBUTING.md).
24-
You can look through the issues (which should be up-to-date on who is working on which features
24+
You can look through the GitHub issues (which should be up-to-date on who is working on which features
2525
and which pieces are blocked) and make a comment.
26-
Also see our [`help wanted`](https://github.com/angular/material2/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
27-
label.
26+
27+
Please see our [`help wanted`](https://github.com/angular/material2/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
28+
label for a list of issues where we could use help from the community.
2829

2930
#### High level stuff planned for Q1 → Q2 2019 (January - June):
3031
* Most of the Angular Material team is on loan to the framework team
@@ -81,19 +82,9 @@ label.
8182
| ---------------- | ------------------------------------------------------ | ------------ |
8283
| theming | | [Guide][20] |
8384
| typography | | [Guide][27] |
84-
| layout | See [angular/flex-layout][lay_rp] | [Uncyclo][0] |
85+
| layout | See [CDK Layout][cdk-layout] or [@angular/flex-layout][lay_rp]| - |
8586
| cdk | | [Docs][34] |
8687

87-
88-
#### In progress, planned, and non-planned features
89-
90-
| Feature | Status | Docs | Issue |
91-
|------------------|-------------------------------------|--------------|----------------|
92-
| fab speed-dial | Not started, not planned | - | [#860][0860] |
93-
| fab toolbar | Not started, not planned | - | - |
94-
| bottom-nav | Not started, not planned | - | [#408][0408] |
95-
96-
[0]: https://github.com/angular/flex-layout/wiki
9788
[1]: https://material.angular.io/components/button/overview
9889
[2]: https://material.angular.io/components/card/overview
9990
[3]: https://material.angular.io/components/checkbox/overview
@@ -124,7 +115,7 @@ label.
124115
[28]: https://material.angular.io/components/table/overview
125116
[29]: https://material.angular.io/components/paginator/overview
126117
[30]: https://material.angular.io/components/sort/overview
127-
[31]: https://tina-material-tree.firebaseapp.com/simple-tree
118+
128119
[32]: https://material.angular.io/components/expansion/overview
129120
[33]: https://material.angular.io/components/stepper/overview
130121
[34]: https://material.angular.io/cdk/categories
@@ -135,35 +126,17 @@ label.
135126
[39]: https://material.angular.io/cdk/drag-drop/overview
136127
[40]: https://material.angular.io/cdk/scrolling/overview#virtual-scrolling
137128

138-
[0107]: https://github.com/angular/material2/issues/107
139-
[0119]: https://github.com/angular/material2/issues/119
140-
[0108]: https://github.com/angular/material2/issues/108
141-
[0114]: https://github.com/angular/material2/issues/114
142-
[0115]: https://github.com/angular/material2/issues/115
143-
[0118]: https://github.com/angular/material2/issues/118
144-
[0546]: https://github.com/angular/material2/issues/546
145-
[0117]: https://github.com/angular/material2/issues/117
146-
[0120]: https://github.com/angular/material2/issues/120
147-
[0123]: https://github.com/angular/material2/issues/123
148-
[0205]: https://github.com/angular/material2/issues/205
149-
[0860]: https://github.com/angular/material2/issues/860
150-
[0408]: https://github.com/angular/material2/issues/408
151-
[0508]: https://github.com/angular/material2/issues/508
152-
[0823]: https://github.com/angular/material2/issues/823
153-
[0581]: https://github.com/angular/material2/issues/581
154-
[4191]: https://github.com/angular/material2/pull/4191
155-
[0995]: https://github.com/angular/material2/pull/995
156-
[0474]: https://github.com/angular/material2/pull/474
157-
158129
[aio]: https://material.angular.io
159130
[getting-started]: https://material.angular.io/guide/getting-started
160131
[lay_rp]: https://github.com/angular/flex-layout
132+
[cdk-layout]: https://material.angular.io/cdk/layout/overview
161133

162134

163-
## The goal of Angular Material
164-
Our goal is to build a set of high-quality UI components built with Angular and TypeScript,
165-
following the Material Design spec. These
166-
components will serve as an example of how to write Angular code following best practices.
135+
## The goal of Angular Material and the CDK
136+
Our goal is to build a set of high-quality UI components built with Angular and TypeScript.
137+
These include foundational components and services, found in the CDK, and components that follow
138+
the Material Design spec. These components serve as an example of how to build Angular UI components
139+
that follow best practices.
167140

168141
### What do we mean by "high-quality"?
169142
* Internationalized and accessible so that all users can use them.
@@ -172,13 +145,15 @@ components will serve as an example of how to write Angular code following best
172145
* Behavior is well-tested with both unit and integration tests.
173146
* Customizable within the bounds of the Material Design specification.
174147
* Performance cost is minimized.
175-
* Code is clean and well-documented to serve as an example for Angular devs.
148+
* Code is clean and well-documented to serve as an example for Angular developers.
176149

177150
## Browser and screen reader support
178151
Angular Material supports the most recent two versions of all major browsers:
179-
Chrome (including Android), Firefox, Safari (including iOS), and IE11 / Edge
180-
181-
We also aim for great user experience with the following screen readers:
182-
* NVDA and JAWS with IE / FF / Chrome (on Windows).
183-
* VoiceOver with Safari on iOS and Safari / Chrome on OSX.
184-
* TalkBack with Chrome on Android.
152+
Chrome (including Android), Firefox, Safari (including iOS), and IE11 / Edge.
153+
154+
We aim for great user experience with the following screen readers:
155+
* **Windows**: NVDA and JAWS with IE11 / FF / Chrome.
156+
* **macOS**: VoiceOver with Safari / Chrome.
157+
* **iOS**: VoiceOver with Safari
158+
* **Android**: Android Accessibility Suite (formerly TalkBack) with Chrome.
159+
* **Chrome OS**: ChromeVox with Chrome.

0 commit comments

Comments
 (0)