diff --git a/README.md b/README.md new file mode 100644 index 0000000..27b45ce --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ + + +# 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 + +Install the module to your Nuxt application with one command: + +```bash +npx nuxi module add nuxt-craftcms +``` + +That's it! You can now use My Module in your Nuxt app ✨ + + +## Contribution + +
+ Local 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/nuxt-craftcms/latest.svg?style=flat&colorA=020420&colorB=00DC82 +[npm-version-href]: https://npmjs.com/package/nuxt-craftcms + +[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-craftcms.svg?style=flat&colorA=020420&colorB=00DC82 +[npm-downloads-href]: https://npmjs.com/package/nuxt-craftcms + +[license-src]: https://img.shields.io/npm/l/nuxt-craftcms.svg?style=flat&colorA=020420&colorB=00DC82 +[license-href]: https://npmjs.com/package/nuxt-craftcms + +[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js +[nuxt-href]: https://nuxt.com