LouisMazel/maz-ui

# maz-ui

[![vue 3](https://img.shields.io/badge/vue-3-42b983.svg)](https://vuejs.org)
[![nuxt 3](https://img.shields.io/badge/nuxt-3-42b983.svg)](https://v3.nuxtjs.org/)

[![types](https://badgen.net/npm/types/maz-ui)](https://www.npmjs.com/package/maz-ui)
[![npm](https://img.shields.io/npm/v/maz-ui/latest.svg)](https://www.npmjs.com/package/maz-ui)
[![license](https://badgen.net/npm/license/lodash)](https://www.npmjs.com/package/maz-ui)
[![Downloads](https://badgen.net/npm/dm/maz-ui)](https://npm-stat.com/charts.html?package=maz-ui)

<!-- [![bundlephobia_tree](https://badgen.net/bundlephobia/tree-shaking/maz-ui)](https://bundlephobia.com/package/maz-ui)
[![bundlephobia_zip](https://badgen.net/bundlephobia/min/maz-ui)](https://bundlephobia.com/package/maz-ui)
[![bundlephobia_zip](https://badgen.net/bundlephobia/minzip/maz-ui)](https://bundlephobia.com/package/maz-ui)
[![bundlephobia_deps](https://badgen.net/bundlephobia/dependency-count/maz-ui)](https://bundlephobia.com/package/maz-ui) -->

[![maintainability](https://api.codeclimate.com/v1/badges/6b27047dcf150ccddfac/maintainability)](https://codeclimate.com/github/LouisMazel/maz-ui/maintainability)
[![test_coverage](https://api.codeclimate.com/v1/badges/6b27047dcf150ccddfac/test_coverage)](https://codeclimate.com/github/LouisMazel/maz-ui/test_coverage)
![github-actions-test-unit](https://github.com/LouisMazel/maz-ui/actions/workflows/lib-test-unit.yml/badge.svg)

> [maz-ui](https://maz-ui.com/) is a standalone components library and tools for [Vue.JS](https://vuejs.org) & [Nuxt.JS](https://nuxtjs.org/) (v3.x)

## Documentation & Components

[Documentation & Components](https://maz-ui.com/)

## Install

### maz-ui

[Getting Started](https://maz-ui.com/guide/getting-started)

```bash
npm install maz-ui
```

### Nuxt Module

[Documentation](https://maz-ui.com/guide/nuxt)

```bash
npm install maz-ui
```

```ts
// nuxt.config.js

export default defineNuxtConfig({
  modules: ['maz-ui/nuxt'],
  mazUi: {
    // Options
  },
})
```

All options of the module are available [here](https://maz-ui.com/guide/nuxt)

### @mazui/cli (theme generator)

[Documentation & Commands](https://maz-ui.com/guide/cli)

```bash
npm install @mazui/cli
```

## Contributing

Please follow this [documentation](./CONTRIBUTING.md)

## LICENSE

[MIT](LICENSE)