material-design-lite/README.md

90 lines
3.9 KiB
Markdown
Raw Permalink Normal View History

# Material Design Lite
2014-04-16 06:26:21 -07:00
2016-02-02 03:10:32 -08:00
[![GitHub version](https://badge.fury.io/gh/google%2Fmaterial-design-lite.svg)](https://badge.fury.io/gh/google%2Fmaterial-design-lite)
[![npm version](https://badge.fury.io/js/material-design-lite.svg)](https://badge.fury.io/js/material-design-lite)
[![Bower version](https://badge.fury.io/bo/material-design-lite.svg)](https://badge.fury.io/bo/material-design-lite)
2015-12-21 02:41:03 -08:00
[![Gitter version](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/google/material-design-lite)
2016-02-02 03:10:32 -08:00
[![Dependency Status](https://david-dm.org/google/material-design-lite.svg)](https://david-dm.org/google/material-design-lite)
2015-10-18 21:30:37 -07:00
> An implementation of [Material Design](http://www.google.com/design/spec/material-design/introduction.html)
components in vanilla CSS, JS, and HTML.
2015-02-04 22:46:41 -08:00
Material Design Lite (MDL) lets you add a Material Design look and feel to your
static content websites. It doesn't rely on any JavaScript frameworks or
libraries. Optimized for cross-device use, gracefully degrades in older
browsers, and offers an experience that is accessible from the get-go.
2016-12-16 10:02:40 -08:00
> ### Limited support
2016-12-16 10:02:40 -08:00
> Material Design Lite is now in limited support, with development having moved to the
> [Material Components for the web](https://github.com/material-components/material-components-web) repository.
2016-12-16 10:02:40 -08:00
> No further development is taking place in MDL by the core team, but we are happy to review PRs, fix critical bugs and
> push out new releases. No breaking changes will be accepted.
## Use MDL on your site?
2015-02-09 06:20:21 -08:00
**This document is targeted at developers that will contribute to or compile
MDL. If you are looking to use MDL on your website or web app please head to
[getmdl.io](http://getmdl.io).**
2014-04-16 07:12:57 -07:00
2016-12-16 10:02:40 -08:00
## Browser Support
| IE9 | IE10 | IE11 | Chrome | Opera | Firefox | Safari | Chrome (Android) | Mobile Safari |
|-----|------|------|--------|-------|---------|--------|------------------|---------------|
| B | A | A | A | A | A | A | A | A |
A-grade browsers are fully supported. B-grade browsers will gracefully degrade
to our CSS-only experience.
### Download / Clone
2015-06-02 04:55:59 -07:00
Clone the repo using Git:
2015-06-02 04:55:59 -07:00
```bash
git clone https://github.com/google/material-design-lite.git
2015-06-02 04:55:59 -07:00
```
Alternatively you can [download](https://github.com/google/material-design-lite/archive/master.zip)
this repository.
2015-06-02 04:55:59 -07:00
Windows users, if you have trouble compiling due to line endings then make sure
you configure git to checkout the repository with `lf` (unix) line endings. This
can be achieved by setting `core.eol`.
```bash
git config core.eol lf
git config core.autocrlf input
git rm --cached -r .
git reset --hard
```
> Remember, the master branch is considered unstable. Do not use this in
production. Use a tagged state of the repository, npm, or bower for stability!
2015-03-30 05:36:22 -07:00
## Feature requests
2016-12-16 10:02:40 -08:00
MDL is currently in limited support mode, with no further development taking place by the core team.
We are happy to accept and review pull requests for new functionality, however, as long as there are no breaking
changes.
## Want to contribute?
If you found a bug, have any questions or want to contribute. Follow our
[guidelines](https://github.com/google/material-design-lite/blob/mdl-1.x/CONTRIBUTING.md),
2016-12-16 10:02:40 -08:00
and help improve the Material Design Lite. For more information visit our
[wiki](https://github.com/google/material-design-lite/wiki).
Please use the default branch, `mdl-1.x`.
2015-02-04 22:46:41 -08:00
Take note that [Material Components for Web](https://github.com/material-components/material-components-web), which is MDL v2, is under early Alpha stages (which means everything is a moving target, and we can change anything at any moment). Use with caution.
However, we would absolutely love to have people testing MCW and provide feedback about their experiences using it, especially integrating with other frameworks and libraries.
2014-06-06 05:06:29 -07:00
## License
© Google, 2015. Licensed under an
[Apache-2](https://github.com/google/material-design-lite/blob/master/LICENSE)
license.