From 86b9a2b069439ca24afe1bc536365853d89d5740 Mon Sep 17 00:00:00 2001
From: Behon Baker <53905713+BayBreezy@users.noreply.github.com>
Date: Mon, 21 Oct 2024 14:37:38 -0500
Subject: [PATCH] chore: bump deps and improve docs
---
.automdrc | 1 +
.nuxtrc | 2 +-
LICENSE.md | 21 +
README.md | 257 +-
eslint.config.mjs | 18 +-
package-lock.json | 1649 +--
package.json | 14 +-
playground/README.md | 255 +
playground/app/app.vue | 80 +-
playground/app/assets/main.css | 63 -
playground/app/components/Ui/Button.vue | 69 +
playground/app/components/Ui/Navbar.vue | 36 +
.../app/components/Ui/VueSonner.client.vue | 47 +
playground/app/utils/shared.styles.ts | 29 +
playground/nuxt.config.ts | 25 +-
playground/package-lock.json | 9210 +++++++++++------
playground/package.json | 16 +-
playground/public/UnlayerIcon.png | Bin 0 -> 1282 bytes
playground/public/image.jpg | Bin 0 -> 279960 bytes
playground/sample.json | 1654 ++-
screenshot.png | Bin 81633 -> 0 bytes
src/module.ts | 14 +-
src/runtime/components/EmailEditor.vue | 11 +-
src/runtime/props.ts | 7 +
unlayer.png | Bin 7614 -> 0 bytes
25 files changed, 9196 insertions(+), 4282 deletions(-)
create mode 100644 .automdrc
create mode 100644 LICENSE.md
create mode 100644 playground/README.md
delete mode 100644 playground/app/assets/main.css
create mode 100644 playground/app/components/Ui/Button.vue
create mode 100644 playground/app/components/Ui/Navbar.vue
create mode 100644 playground/app/components/Ui/VueSonner.client.vue
create mode 100644 playground/app/utils/shared.styles.ts
create mode 100644 playground/public/UnlayerIcon.png
create mode 100644 playground/public/image.jpg
delete mode 100644 screenshot.png
delete mode 100644 unlayer.png
diff --git a/.automdrc b/.automdrc
new file mode 100644
index 0000000..1a31cf7
--- /dev/null
+++ b/.automdrc
@@ -0,0 +1 @@
+watch=true
\ No newline at end of file
diff --git a/.nuxtrc b/.nuxtrc
index f033419..167e6c7 100644
--- a/.nuxtrc
+++ b/.nuxtrc
@@ -1,2 +1,2 @@
-imports.autoImport=false
+imports.autoImport=true
typescript.includeWorkspace=true
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..044d271
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Behon Baker.
+
+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 de8f777..b1d2903 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,67 @@
-
+# Nuxt Unlayer
-# Nuxt Unlayer
+
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![License][license-src]][license-href]
+[![npm version](https://img.shields.io/npm/v/nuxt-unlayer?color=green)](https://npmjs.com/package/nuxt-unlayer)
+[![npm downloads](https://img.shields.io/npm/dm/nuxt-unlayer?color=green)](https://npm.chart.dev/nuxt-unlayer)
+[![codecov](https://img.shields.io/codecov/c/gh/baybreezy/nuxt-unlayer?color=green)](https://codecov.io/gh/baybreezy/nuxt-unlayer)
+[![license](https://img.shields.io/github/license/baybreezy/nuxt-unlayer?color=green)](https://github.com/baybreezy/nuxt-unlayer/blob/main/LICENSE)
-![Demo Image](./screenshot.png)
+
-> Add the [Unlayer Editor](https://docs.unlayer.com/docs) to your [Nuxt](https://nuxt.com) app easily.
+![Demo Image](./playground/public/image.jpg)
-## Demo
+- [ Nuxt Unlayer](#-nuxt-unlayer)
+ - [ Demo](#-demo)
+ - [ Quick Setup](#-quick-setup)
+ - [ Full Example](#-full-example)
+ - [ Screenshot](#-screenshot)
+ - [Development](#development)
+ - [Contributors](#contributors)
+
+## Demo
The Demo is available at [Nuxt Unlayer Playground](https://nuxt-unlayer.behonbaker.com/)
-## Quick Setup
+## Quick Setup
1. Add `nuxt-unlayer` dependency to your project
-```bash
-# Using yarn
-yarn add --dev nuxt-unlayer
+
+
+```sh
+# ✨ Auto-detect
+npx nypm install nuxt-unlayer
+```
-# Using npm
-npm install --save-dev nuxt-unlayer
+```sh
+# npm
+npm install nuxt-unlayer
```
-2. Add `nuxt-unlayer` to the `modules` section of `nuxt.config.ts`
+```sh
+# yarn
+yarn add nuxt-unlayer
+```
+
+```sh
+# pnpm
+pnpm install nuxt-unlayer
+```
+
+```sh
+# bun
+bun install nuxt-unlayer
+```
+
+```sh
+# deno
+deno install nuxt-unlayer
+```
+
+
+
+1. Add `nuxt-unlayer` to the `modules` section of `nuxt.config.ts`
```js
export default defineNuxtConfig({
@@ -36,92 +71,146 @@ export default defineNuxtConfig({
That's it! You can now use Nuxt Unlayer in your Nuxt app ✨
-## Full Example
+## Full Example
Full Example
-```vue
+
+
+```vue [app.vue]
-