@pinegrow/iles-module 3.0.0-beta.111 → 3.0.0-beta.112

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +77 -3
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -1,6 +1,80 @@
1
- # @pinegrow/iles-module
1
+ <!-- [![@pinegrow/iles-module](https://tailwindcss.nuxtjs.org/social-card.png)](https://tailwindcss.nuxtjs.org) -->
2
2
 
3
- ## Pinegrow Iles module
3
+ # Pinegrow Iles Module
4
4
 
5
- http://www.pinegrow.com
5
+ [![npm version][npm-version-src]][npm-version-href]
6
+ [![npm downloads][npm-downloads-src]][npm-downloads-href]
7
+ [![License][license-src]][license-href]
8
+
9
+ [Iles](https://iles.pages.dev/) module for [Pinegrow](https://pinegrow.com) ⚡️
10
+
11
+ Pinegrow Iles Module enables connection and interaction between your Vite Dev-Server and Pinegrow apps (currently only Vue Designer)."
12
+
13
+ - [📖 &nbsp;Documentation](https://pinegrow.com/vue-designer)
14
+
15
+ ## Features
16
+
17
+ - 🎨&nbsp; Visually live-design your Vite-powered Iles apps
18
+ - ⚙️&nbsp; Smartly integrates into your Iles workflow in dev-mode only
19
+ - ✨&nbsp; No lock-in, Pinegrow is an open-tool ❤️
20
+
21
+ ## Quick Setup
22
+
23
+ 1. Install: Add `@pinegrow/iles-module` to your project
24
+
25
+ ```bash
26
+ # Using npm
27
+ npm install --save-dev @pinegrow/iles-module
28
+
29
+ # Using pnpm
30
+ pnpm add --save-dev @pinegrow/iles-module
31
+ ```
32
+
33
+ 2. Configure: Add `@pinegrow/iles-module` to your Iles Integrations array `iles.config.{js,ts}`
34
+
35
+ ```js
36
+ //iles.config.js (or) iles.config.ts
37
+
38
+ import { defineConfig } from 'iles'
39
+
40
+ export default defineConfig({
41
+ modules: [
42
+ [
43
+ '@pinegrow/iles-module',
44
+ {
45
+ liveDesigner: {
46
+ //...
47
+ },
48
+ // https://github.com/antfu/unplugin-auto-import#configuration
49
+ autoImportAPIs: {
50
+ // imports: [
51
+ // '@vueuse/head',
52
+ // '@vueuse/core',
53
+ // // add presets
54
+ // ],
55
+ },
56
+ },
57
+ ],
58
+ //...
59
+ ],
60
+ //...
61
+ })
62
+ ```
63
+
64
+ Now, open your project in your Pinegrow app (currently only Vue Designer). ✨
65
+
66
+ ## License
67
+
68
+ [MIT License](./LICENSE)
69
+
70
+ Copyright (c) Pinegrow
71
+
72
+ <!-- Badges -->
73
+
74
+ [npm-version-src]: https://img.shields.io/npm/v/@pinegrow/iles-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
75
+ [npm-version-href]: https://npmjs.com/package/@pinegrow/iles-module
76
+ [npm-downloads-src]: https://img.shields.io/npm/dm/@pinegrow/iles-module.svg?style=flat&colorA=18181B&colorB=28CF8D
77
+ [npm-downloads-href]: https://npmjs.com/package/@pinegrow/iles-module
78
+ [license-src]: https://img.shields.io/npm/l/@pinegrow/iles-module.svg?style=flat&colorA=18181B&colorB=28CF8D
79
+ [license-href]: https://npmjs.com/package/@pinegrow/iles-module
6
80
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pinegrow/iles-module",
3
- "version": "3.0.0-beta.111",
3
+ "version": "3.0.0-beta.112",
4
4
  "description": "Pinegrow Iles Module",
5
5
  "author": "Pinegrow (http://pinegrow.com/)",
6
6
  "license": "MIT",
@@ -20,7 +20,9 @@
20
20
  },
21
21
  "keywords": [
22
22
  "pinegrow",
23
- "iles-module"
23
+ "vue-designer",
24
+ "iles-module",
25
+ "@pinegrow/iles-module"
24
26
  ],
25
27
  "scripts": {
26
28
  "dev": "npm run build -- --watch",
@@ -31,7 +33,7 @@
31
33
  "increment-beta-version": "npm version prerelease --preid=beta"
32
34
  },
33
35
  "dependencies": {
34
- "@pinegrow/vite-plugin": "3.0.0-beta.111",
36
+ "@pinegrow/vite-plugin": "3.0.0-beta.112",
35
37
  "node-html-parser": "^6.1.5",
36
38
  "unplugin-auto-import": "^0.15.2"
37
39
  },