Remove boilerplate README

This commit is contained in:
Jarek Rozanski 2023-05-14 15:33:08 +00:00
parent 338c0c6048
commit 33ce331413

View file

@ -1,91 +1,10 @@
<!--
Get your module up and running quickly.
# Wide Angle Analytics Nuxt3 Module
Find and replace all on all files (CMD+SHIFT+F):
- Name: My Module
- Package name: wideangle
- 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.
- [✨ &nbsp;Release Notes](/CHANGELOG.md)
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/wideangle?file=playground%2Fapp.vue) -->
<!-- - [📖 &nbsp;Documentation](https://example.com) -->
## Features
<!-- Highlight some of the features your module provide here -->
- ⛰ &nbsp;Foo
- 🚠 &nbsp;Bar
- 🌲 &nbsp;Baz
## Quick Setup
1. Add `wideangle` dependency to your project
```bash
# Using pnpm
pnpm add -D wideangle
# Using yarn
yarn add --dev wideangle
# Using npm
npm install --save-dev wideangle
```
2. Add `wideangle` to the `modules` section of `nuxt.config.ts`
```js
export default defineNuxtConfig({
modules: [
'wideangle'
]
})
```
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/wideangle/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/wideangle
[npm-downloads-src]: https://img.shields.io/npm/dm/wideangle.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/wideangle
[license-src]: https://img.shields.io/npm/l/wideangle.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/wideangle