@toantranmei/mei-nuxt3-module-starter/README.md

Minimal Nuxt 3 Module Starter.

<!--
Get your module up and running quickly.

Find and replace all on all files (CMD+SHIFT+F):
- Name: Mei Nuxt3 UI Module
- Package name: @toantranmei/mei-nuxt3-module-starter
- Description: Minimal Nuxt 3 Module Starter
-->

# Mei Nuxt3 UI Module

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

About Minimal Nuxt 3 Module Starter, powered by Nuxt 3 for doing amazing things.

- [✨ &nbsp;Release Notes](/CHANGELOG.md)
<!-- - [🏀 Online playground](https://stackblitz.com/github/toantranmei/mei-nuxt3-module-starter?file=playground%2Fapp.vue) -->
<!-- - [📖 &nbsp;Documentation](https://mei-nuxt3-module-starter.toantranmei.com) -->

## Features

<!-- Highlight some of the features your module provide here -->
- ⛰ &nbsp;Foo
- 🚠 &nbsp;Bar
- 🌲 &nbsp;Baz

## Quick Setup

Install the module to your Nuxt application with one command:

```bash
npx nuxi module add @toantranmei/mei-nuxt3-module-starter
```

That's it! You can now use Mei Nuxt3 UI Module in your Nuxt app ✨

## Contribution

<details>
  <summary>Local development</summary>

  ```bash
  # Install dependencies
  npm install

  # Generate type stubs
  npm run dev:prepare

  # Develop with the playground
  npm run dev

  # Build the playground
  npm run dev:build

  # Run ESLint
  npm run lint

  # Run Vitest
  npm run test
  npm run test:watch

  # Release new version
  npm run release
  ```

</details>

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@toantranmei/mei-nuxt3-module-starter/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/@toantranmei/mei-nuxt3-module-starter

[npm-downloads-src]: https://img.shields.io/npm/dm/@toantranmei/mei-nuxt3-module-starter.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npmjs.com/package/@toantranmei/mei-nuxt3-module-starter

[license-src]: https://img.shields.io/npm/l/@toantranmei/mei-nuxt3-module-starter.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/@toantranmei/mei-nuxt3-module-starter

[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com