|
1 |
| -<!-- |
2 |
| -Get your module up and running quickly. |
3 |
| -
|
4 |
| -Find and replace all on all files (CMD+SHIFT+F): |
5 |
| -- Name: My Module |
6 |
| -- Package name: my-module |
7 |
| -- Description: My new Nuxt module |
8 |
| ---> |
9 |
| - |
10 |
| -# My Module |
| 1 | +# Nuxt Listmonk |
11 | 2 |
|
12 | 3 | [![npm version][npm-version-src]][npm-version-href]
|
13 | 4 | [![npm downloads][npm-downloads-src]][npm-downloads-href]
|
14 | 5 | [![License][license-src]][license-href]
|
15 | 6 | [![Nuxt][nuxt-src]][nuxt-href]
|
16 | 7 |
|
17 |
| -My new Nuxt module for doing amazing things. |
| 8 | +> Maintenance module for [Nuxt.js](https://nuxt.com/) |
18 | 9 |
|
19 |
| -- [✨ Release Notes](/CHANGELOG.md) |
20 |
| -<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) --> |
21 |
| -<!-- - [📖 Documentation](https://example.com) --> |
| 10 | +- [Release Notes](https://github.com/roncallyt/nuxt-listmonk/releases) |
| 11 | +- [Documentation](https://nuxt-listmonk.t7n.dev) |
| 12 | +<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/nuxt-listmonk?file=playground%2Fapp.vue) --> |
22 | 13 |
|
23 | 14 | ## Features
|
24 | 15 |
|
25 | 16 | <!-- Highlight some of the features your module provide here -->
|
26 |
| -- ⛰ Foo |
27 |
| -- 🚠 Bar |
28 |
| -- 🌲 Baz |
| 17 | +- Nuxt 3 ready |
| 18 | +- Typescript support |
29 | 19 |
|
30 | 20 | ## Quick Setup
|
31 | 21 |
|
32 |
| -Install the module to your Nuxt application with one command: |
| 22 | +1. Add `nuxt-listmonk` dependency to your project: |
33 | 23 |
|
34 | 24 | ```bash
|
35 |
| -npx nuxi module add my-module |
| 25 | +npx nuxi module add nuxt-listmonk |
36 | 26 | ```
|
37 | 27 |
|
38 |
| -That's it! You can now use My Module in your Nuxt app ✨ |
| 28 | +2. Add `nuxt-listmonk` to the `modules` section of `nuxt.config.ts`: |
39 | 29 |
|
| 30 | +```js |
| 31 | +export default defineNuxtConfig({ |
| 32 | + modules: ['nuxt-listmonk'], |
| 33 | +}); |
| 34 | +``` |
| 35 | +That's it! You can now use Listmonk in your Nuxt app ✨ |
40 | 36 |
|
41 | 37 | ## Contribution
|
42 | 38 |
|
@@ -69,16 +65,21 @@ That's it! You can now use My Module in your Nuxt app ✨
|
69 | 65 |
|
70 | 66 | </details>
|
71 | 67 |
|
| 68 | +## Support |
| 69 | + |
| 70 | +Hi, I am Thomerson Roncally, a Fullstack Developer that love to build things to help other developers. If you like my work and want to support me, you can donate here: |
| 71 | + |
| 72 | +[](https://ko-fi.com/roncallyt) |
72 | 73 |
|
73 | 74 | <!-- Badges -->
|
74 |
| -[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82 |
75 |
| -[npm-version-href]: https://npmjs.com/package/my-module |
| 75 | +[npm-version-src]: https://img.shields.io/npm/v/nuxt-listmonk/latest.svg?style=flat&colorA=020420&colorB=00DC82 |
| 76 | +[npm-version-href]: https://npmjs.com/package/nuxt-listmonk |
76 | 77 |
|
77 |
| -[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=020420&colorB=00DC82 |
78 |
| -[npm-downloads-href]: https://npm.chart.dev/my-module |
| 78 | +[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-listmonk.svg?style=flat&colorA=020420&colorB=00DC82 |
| 79 | +[npm-downloads-href]: https://npm.chart.dev/nuxt-listmonk |
79 | 80 |
|
80 |
| -[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=020420&colorB=00DC82 |
81 |
| -[license-href]: https://npmjs.com/package/my-module |
| 81 | +[license-src]: https://img.shields.io/npm/l/nuxt-listmonk.svg?style=flat&colorA=020420&colorB=00DC82 |
| 82 | +[license-href]: https://npmjs.com/package/nuxt-listmonk |
82 | 83 |
|
83 | 84 | [nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
|
84 | 85 | [nuxt-href]: https://nuxt.com
|
0 commit comments