From 7adcc3770865e9a5d3353edc22d3f848323747bb Mon Sep 17 00:00:00 2001 From: NISHANT SINGH <166104326+NishantSingh825@users.noreply.github.com> Date: Sat, 3 May 2025 16:20:38 +0530 Subject: [PATCH] Update README.md --- README.md | 101 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 56 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index b701c39d2..fd4321263 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Material Design Lite +# ๐ŸŽจ Material Design Lite [![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) @@ -6,52 +6,55 @@ [![Gitter version](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/google/material-design-lite) [![Dependency Status](https://david-dm.org/google/material-design-lite.svg)](https://david-dm.org/google/material-design-lite) -> An implementation of [Material Design](http://www.google.com/design/spec/material-design/introduction.html) -components in vanilla CSS, JS, and HTML. +> โœจ A lightweight implementation of [Material Design](http://www.google.com/design/spec/material-design/introduction.html) components in vanilla **CSS**, **JS**, and **HTML**. -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. +--- -> ### Limited support +## ๐Ÿš€ What is MDL? -> 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. +Material Design Lite (MDL) lets you add a **Material Design look and feel** to your static content websites. +โœ… No frameworks required +โœ… Cross-device optimized +โœ… Accessible and responsive +โœ… Graceful degradation in older browsers -> 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? +> โš ๏ธ **Limited Support Notice** +> MDL is in **limited support**. Development has moved to ๐Ÿ‘‰ [Material Components for the Web](https://github.com/material-components/material-components-web). +> PRs are welcome, but no **breaking changes** will be accepted. -**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).** +--- -## Browser Support +## ๐Ÿง‘โ€๐Ÿ’ป Use MDL on your site? +This guide is intended for developers contributing to or compiling MDL. +If you're just looking to use MDL on your project, visit ๐Ÿ‘‰ [getmdl.io](http://getmdl.io) + +--- + +## ๐ŸŒ Browser Support | IE9 | IE10 | IE11 | Chrome | Opera | Firefox | Safari | Chrome (Android) | Mobile Safari | |-----|------|------|--------|-------|---------|--------|------------------|---------------| -| B | A | A | A | A | A | A | A | A | +| ๐ŸŸก 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. +- ๐ŸŸข **A-grade**: Fully supported +- ๐ŸŸก **B-grade**: CSS-only fallback -### Download / Clone +--- -Clone the repo using Git: +## ๐Ÿ“ฆ Download / Clone + +Clone using Git: ```bash git clone https://github.com/google/material-design-lite.git ``` -Alternatively you can [download](https://github.com/google/material-design-lite/archive/master.zip) -this repository. +Or download it directly ๐Ÿ‘‰ [Download ZIP](https://github.com/google/material-design-lite/archive/master.zip) -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`. +๐ŸชŸ **Windows Users**: Fix line endings issues: ```bash git config core.eol lf @@ -60,30 +63,38 @@ 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! +> ๐Ÿ›‘ The `master` branch is **unstable**. Use a **tagged release**, **npm**, or **bower** for stable builds. + +--- + +## ๐Ÿ’ก Feature Requests + +MDL is in limited support. +โœ… We **accept PRs** for enhancements +โ›” No breaking changes will be merged + +--- + +## ๐Ÿค Want to Contribute? -## Feature requests +Found a bug ๐Ÿž? Have a cool feature ๐Ÿ’ก? Want to contribute ๐Ÿ‘จโ€๐Ÿ”ง? -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. +Check our ๐Ÿ‘‰ [Contributing Guidelines](https://github.com/google/material-design-lite/blob/mdl-1.x/CONTRIBUTING.md) +More info here ๐Ÿ‘‰ [MDL Wiki](https://github.com/google/material-design-lite/wiki) -## Want to contribute? +> Use the `mdl-1.x` branch for your PRs. -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), -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`. +### ๐Ÿงช Looking Ahead -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. +Check out [Material Components for Web](https://github.com/material-components/material-components-web) โ€” MDL v2! +๐Ÿšง **Still in Alpha**: Everything is a moving target. +We'd โค๏ธ your feedback on integration and usage! -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. +--- -## License +## ๐Ÿ“„ License -ยฉ Google, 2015. Licensed under an -[Apache-2](https://github.com/google/material-design-lite/blob/master/LICENSE) -license. +ยฉ Google, 2015 +Licensed under the [Apache-2.0 License](https://github.com/google/material-design-lite/blob/master/LICENSE)