diff --git a/README.md b/README.md index 6a75df66d..b846ae1dd 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,83 @@ # Material Web -Material -[web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) -is a UI toolkit to build customizable and accessible web applications. +A collection of Material web components -[Material 3](https://m3.material.io/) is the latest version of -Google's open-source design system. +[![Published on npm](https://img.shields.io/npm/v/%40material%2Fweb)](https://www.npmjs.com/package/@material/web) +[![Join our Discord](https://img.shields.io/badge/discord-join%20chat-5865F2.svg?logo=discord&logoColor=fff&label=%23material)](https://lit.dev/discord/) +[![Test status](https://github.com/material-components/material-web/actions/workflows/test.yml/badge.svg)](https://github.com/material-components/material-web/actions/workflows/test.yml) +[![npm Downloads](https://img.shields.io/npm/dm/%40material%2Fweb?label=npm%20downloads)](https://npm-stat.com/charts.html?package=%40material%2Fweb) +[![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hm/%40material%2Fweb)](https://www.jsdelivr.com/package/npm/@material/web?tab=stats) + +`@material/web` is a library of +[web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) +that helps build beautiful and accessible web applications. It uses +[Material 3](https://m3.material.io/), the latest version of Google's +open-source design system. + +## Resources + +- [Introduction](./docs/intro.md) +- [Roadmap](./docs/roadmap.md) +- [Component docs](./docs/components/) +- [Bundle size](./docs/size.md) +- [Browser support and FAQ](./docs/support.md) + +## Quick start > Tip: Using Angular? We recommend using > [Angular Material](https://material.angular.io/) components > instead. -**Resources** +This code snippet is a buildless example that loads `@material/web` from a CDN. +Check out the [quick start](./docs/quick-start.md) guide to install and build +for production. -- [Introduction](./docs/intro.md) -- [Roadmap](./docs/roadmap.md) -- [Quick start](./docs/quick-start.md) -- [Bundle sizes](./docs/size.md) -- [Component docs](./docs/components/) -- [Browser support and FAQ](./docs/support.md) + + +```html + + + + + + +

Hello Material!

+
+

Check out these controls in a form!

+ +
+ + + +
+ + + + Reset +
+ + +``` + + diff --git a/docs/images/material-web.gif b/docs/images/material-web.gif new file mode 100644 index 000000000..68af3f3a9 Binary files /dev/null and b/docs/images/material-web.gif differ diff --git a/docs/quick-start.md b/docs/quick-start.md index bfa5da750..ded7dc57f 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -8,7 +8,7 @@ order: 2 @@ -16,6 +16,60 @@ tag: 'docType:gettingStarted' +## CDN + +For fast prototyping, we recommend using [esm.run](https://esm.run/), +a CDN that allows you to use `@material/web` without installing and building +from NPM. + + + +```html + + + + + + +

Hello Material!

+
+

Check out these controls in a form!

+ +
+ + + +
+ + Reset +
+ + +``` + + + +For production, follow the [install](#install) and [build](#building) steps +below. + ## Install