diff --git a/README.md b/README.md index 9b717f599b1..c2072753b88 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,26 @@ This is the home for the Angular team's Material Design components built on top of Angular 2. Things are in very early stages now- check back soon for more progress. + +## The goal of Angular Material +Our goal is to build a set of high-quality UI components built with Angular 2 and TypeScript, +following the Material Design spec, that are consumable by both JavaScript and Dart. These +components will serve as an example of how to write Angular code following best practices. + +### What do we mean by "high-quality"? +* Internationalized and accessible so that all users can use them. +* Straightforward APIs that don't confuse developers. +* Behave as expected across a wide variety of use-cases without bugs. +* Behavior is well-tested with both unit and integration tests. +* Customizable within the bounds of the Material Design specification. +* Performance cost is minimized +* Code is clean and well-documented to serve as an example for Angular devs. + +## Browser and screen reader support +Angular Material supports the most recent two versions of all major browsers: +Chrome (including Android), Firefox, Safari (including iOS), and IE11 / Edge + +We also aim for great user experience with the following screen readers: +* NVDA and JAWS with IE / FF / Chrome (on Windows). +* VoiceOver with Safari on iOS and Safari / Chrome on OSX. +* TalkBack with Chrome on Android.