@sandlada/mdc/README.md

@sandlada/mdc is an open source component library that follows the Material Design 3 design specifications.

# @sandlada/mdc

![MDC Logo](https://raw.githubusercontent.com/sandlada/mdc/refs/heads/main/docs/mdc-cover.png)

![NPM Downloads](https://img.shields.io/npm/d18m/@sandlada/mdc?label=NPM%20Downloads)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/sandlada/mdc/total?label=Github%20Downloads)
![NPM Version](https://img.shields.io/npm/v/%40sandlada%2Fmdc?label=NPM%20Version)
![GitHub License](https://img.shields.io/github/license/sandlada/mdc?label=License)

_**@sandlada/vue-mdc is deprecated. We will migrate from @sandlada/vue-mdc to @sandlada/mdc.**_

**Currently in development.**

`@sandlada/mdc` is an open source component library that follows the Material Design 3 design specifications.

Written by Lit Framework, relying on the cross-framework capabilities of Lit and Web Component, you can use this library on any framework (Vue, Angular, React, etc.).

## :zap: Highlights

- Material Design 3
- Written in Lit Framework

## :eyes: Installation

```bash
npm i @sandlada/mdc
```

## :ship: Example

Don't know how to use MDC? Explore MDC with simple examples from [Github Wiki - Examples](https://github.com/sandlada/mdc/wiki/Examples).

_If you want to showcase something you've created with MDC, please contact me._

## :ledger: Documents

For more information about MDC, please visit [mdc.sandlada.com](https://mdc.sandlada.com).

_The document is being edited and the content will be presented soon._

## :world_map: Roadmap

If you want to follow the latest progress of MDC, please jump to issue [Project Tracker](https://github.com/sandlada/mdc/issues/6).