diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d52bbe5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Vue Email + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index c51b6b0..8423d3d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Get your module up and running quickly. Find and replace all on all files (CMD+SHIFT+F): - Name: My Module -- Package name: my-module +- Package name: @vue-email/nuxt - Description: My new Nuxt module --> @@ -14,40 +14,34 @@ Find and replace all on all files (CMD+SHIFT+F): [![License][license-src]][license-href] [![Nuxt][nuxt-src]][nuxt-href] -My new Nuxt module for doing amazing things. +Vue Email Nuxt Module. -- [✨  Release Notes](/CHANGELOG.md) - - +## Documentation -## Features +Visit https://www.vuemail.net/ssr/nuxt to explore the documentation. - -- ⛰  Foo -- 🚠  Bar -- 🌲  Baz ## Quick Setup -1. Add `my-module` dependency to your project +1. Add `@vue-email/nuxt` dependency to your project ```bash # Using pnpm -pnpm add -D my-module +pnpm add -D @vue-email/nuxt # Using yarn -yarn add --dev my-module +yarn add --dev @vue-email/nuxt # Using npm -npm install --save-dev my-module +npm install --save-dev @vue-email/nuxt ``` -2. Add `my-module` to the `modules` section of `nuxt.config.ts` +2. Add `@vue-email/nuxt` to the `modules` section of `nuxt.config.ts` ```js export default defineNuxtConfig({ modules: [ - 'my-module' + '@vue-email/nuxt' ] }) ``` @@ -80,15 +74,20 @@ npm run test:watch npm run release ``` +## License + +[MIT](./LICENSE) License © 2023-PRESENT [Vue Email](https://vuemail.net/) + + -[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/@vue-email/nuxt/latest.svg?style=flat&colorA=18181B&colorB=28CF8D +[npm-version-href]: https://npmjs.com/package/@vue-email/nuxt -[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/@vue-email/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D +[npm-downloads-href]: https://npmjs.com/package/@vue-email/nuxt -[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/@vue-email/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D +[license-href]: https://npmjs.com/package/@vue-email/nuxt [nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js [nuxt-href]: https://nuxt.com