diff --git a/README.md b/README.md index 5fb232c..29a6e90 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,10 @@ - - -# 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) - - - -## Features - - -- ⛰  Foo -- 🚠  Bar -- 🌲  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 -``` -[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