Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
StevenJPx2 committed Sep 18, 2023
1 parent 6f73727 commit aaac6cc
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
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
- Name: Nuxt SplitType
- Package name: nuxt-split-type
- Description: Nuxt integration for SplitType.
-->

# My Module
# Nuxt SplitType

[![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.
Nuxt integration for SplitType.

- [ Release Notes](/CHANGELOG.md)
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/nuxt-split-type?file=playground%2Fapp.vue) -->
<!-- - [📖 &nbsp;Documentation](https://example.com) -->

## Features
Expand All @@ -29,30 +29,30 @@ My new Nuxt module for doing amazing things.

## Quick Setup

1. Add `my-module` dependency to your project
1. Add `nuxt-split-type` dependency to your project

```bash
# Using pnpm
pnpm add -D my-module
pnpm add -D nuxt-split-type

# Using yarn
yarn add --dev my-module
yarn add --dev nuxt-split-type

# Using npm
npm install --save-dev my-module
npm install --save-dev nuxt-split-type
```

2. Add `my-module` to the `modules` section of `nuxt.config.ts`
2. Add `nuxt-split-type` to the `modules` section of `nuxt.config.ts`

```js
export default defineNuxtConfig({
modules: [
'my-module'
'nuxt-split-type'
]
})
```

That's it! You can now use My Module in your Nuxt app ✨
That's it! You can now use Nuxt SplitType in your Nuxt app ✨

## Development

Expand Down Expand Up @@ -81,14 +81,14 @@ 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-version-src]: https://img.shields.io/npm/v/nuxt-split-type/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/nuxt-split-type

[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
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-split-type.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/nuxt-split-type

[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
[license-src]: https://img.shields.io/npm/l/nuxt-split-type.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/nuxt-split-type

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

0 comments on commit aaac6cc

Please sign in to comment.