|
@@ -0,0 +1,93 @@
|
|
|
|
+<!--
|
|
|
|
+Get your module up and running quickly.
|
|
|
|
+
|
|
|
|
+Find and replace all on all files (CMD+SHIFT+F):
|
|
|
|
+- Name: My Module
|
|
|
|
+- Package name: my-module
|
|
|
|
+- Description: My new Nuxt module
|
|
|
|
+-->
|
|
|
|
+
|
|
|
|
+# My 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]
|
|
|
|
+
|
|
|
|
+My new Nuxt module for doing amazing things.
|
|
|
|
+
|
|
|
|
+- [✨ Release Notes](/CHANGELOG.md)
|
|
|
|
+<!-- - [📖 Documentation](https://example.com) -->
|
|
|
|
+
|
|
|
|
+## Features
|
|
|
|
+
|
|
|
|
+<!-- Highlight some of the features your module provide here -->
|
|
|
|
+- ⛰ Foo
|
|
|
|
+- 🚠 Bar
|
|
|
|
+- 🌲 Baz
|
|
|
|
+
|
|
|
|
+## Quick Setup
|
|
|
|
+
|
|
|
|
+1. Add `my-module` dependency to your project
|
|
|
|
+
|
|
|
|
+```bash
|
|
|
|
+# Using pnpm
|
|
|
|
+pnpm add -D my-module
|
|
|
|
+
|
|
|
|
+# Using yarn
|
|
|
|
+yarn add --dev my-module
|
|
|
|
+
|
|
|
|
+# Using npm
|
|
|
|
+npm install --save-dev my-module
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+2. Add `my-module` to the `modules` section of `nuxt.config.ts`
|
|
|
|
+
|
|
|
|
+```js
|
|
|
|
+export default defineNuxtConfig({
|
|
|
|
+ modules: [
|
|
|
|
+ 'my-module'
|
|
|
|
+ ]
|
|
|
|
+})
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+That's it! You can now use My Module in your Nuxt app ✨
|
|
|
|
+
|
|
|
|
+## Development
|
|
|
|
+
|
|
|
|
+```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
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+<!-- Badges -->
|
|
|
|
+[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
|
|
+[npm-version-href]: https://npmjs.com/package/my-module
|
|
|
|
+
|
|
|
|
+[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
|
|
+[npm-downloads-href]: https://npmjs.com/package/my-module
|
|
|
|
+
|
|
|
|
+[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
|
|
+[license-href]: https://npmjs.com/package/my-module
|
|
|
|
+
|
|
|
|
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
|
|
|
|
+[nuxt-href]: https://nuxt.com
|