Skip to content

Commit 6d91fb7

Browse files
committed
docs: Update README
1 parent a3f990d commit 6d91fb7

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,38 @@
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
112

123
[![npm version][npm-version-src]][npm-version-href]
134
[![npm downloads][npm-downloads-src]][npm-downloads-href]
145
[![License][license-src]][license-href]
156
[![Nuxt][nuxt-src]][nuxt-href]
167

17-
My new Nuxt module for doing amazing things.
8+
> Maintenance module for [Nuxt.js](https://nuxt.com/)
189
19-
- [&nbsp;Release Notes](/CHANGELOG.md)
20-
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
21-
<!-- - [📖 &nbsp;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) -->
2213

2314
## Features
2415

2516
<!-- Highlight some of the features your module provide here -->
26-
-&nbsp;Foo
27-
- 🚠 &nbsp;Bar
28-
- 🌲 &nbsp;Baz
17+
- Nuxt 3 ready
18+
- Typescript support
2919

3020
## Quick Setup
3121

32-
Install the module to your Nuxt application with one command:
22+
1. Add `nuxt-listmonk` dependency to your project:
3323

3424
```bash
35-
npx nuxi module add my-module
25+
npx nuxi module add nuxt-listmonk
3626
```
3727

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`:
3929

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 ✨
4036

4137
## Contribution
4238

@@ -69,16 +65,21 @@ That's it! You can now use My Module in your Nuxt app ✨
6965

7066
</details>
7167

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+
[![ko-fi](https://www.ko-fi.com/img/donate_sm.png)](https://ko-fi.com/roncallyt)
7273

7374
<!-- 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
7677

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
7980

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
8283

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

0 commit comments

Comments
 (0)