@pinegrow/astro-module 3.0.0-beta.111 → 3.0.0-beta.113

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 +85 -3
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -1,6 +1,88 @@
1
- # @pinegrow/astro-module
1
+ <!-- [![@pinegrow/astro-module](https://tailwindcss.nuxtjs.org/social-card.png)](https://tailwindcss.nuxtjs.org) -->
2
2
 
3
- ## Pinegrow Astro module
3
+ # Pinegrow Astro 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
+ [Astro](https://astro.build/) module for [Pinegrow](https://pinegrow.com) ⚡️
10
+
11
+ Pinegrow Astro 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 Astro apps (currently only Vue components are supported)
18
+ - ⚙️&nbsp; Smartly integrates into your Astro 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/astro-module` to your project
24
+
25
+ ```bash
26
+ # Using npm
27
+ npm install --save-dev @pinegrow/astro-module
28
+
29
+ # Using pnpm
30
+ pnpm add --save-dev @pinegrow/astro-module
31
+ ```
32
+
33
+ 2. Configure: Add `@pinegrow/astro-module` to your Astro Integrations array `astro.config.{mjs,ts}`
34
+
35
+ ```js
36
+ //astro.config.mjs (or) astro.config.ts
37
+
38
+ import { defineConfig } from 'astro/config'
39
+
40
+ import vue from '@astrojs/vue'
41
+ import pinegrow from '@pinegrow/astro-module'
42
+
43
+ export default defineConfig({
44
+ integrations: [
45
+ vue(),
46
+ pinegrow({
47
+ liveDesigner: {
48
+ //...
49
+ },
50
+ // https://github.com/antfu/unplugin-vue-components#configuration
51
+ autoImportComponents: {
52
+ // dirs: ['src/components'], // default
53
+ // resolvers: [
54
+ // // add resolvers
55
+ // ],
56
+ },
57
+ // https://github.com/antfu/unplugin-auto-import#configuration
58
+ autoImportAPIs: {
59
+ // imports: [
60
+ // '@vueuse/head',
61
+ // '@vueuse/core',
62
+ // // add presets
63
+ // ],
64
+ },
65
+ }),
66
+ //...
67
+ ],
68
+ //...
69
+ })
70
+ ```
71
+
72
+ Now, open your project in your Pinegrow app (currently only Vue Designer). ✨
73
+
74
+ ## License
75
+
76
+ [MIT License](./LICENSE)
77
+
78
+ Copyright (c) Pinegrow
79
+
80
+ <!-- Badges -->
81
+
82
+ [npm-version-src]: https://img.shields.io/npm/v/@pinegrow/astro-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
83
+ [npm-version-href]: https://npmjs.com/package/@pinegrow/astro-module
84
+ [npm-downloads-src]: https://img.shields.io/npm/dm/@pinegrow/astro-module.svg?style=flat&colorA=18181B&colorB=28CF8D
85
+ [npm-downloads-href]: https://npmjs.com/package/@pinegrow/astro-module
86
+ [license-src]: https://img.shields.io/npm/l/@pinegrow/astro-module.svg?style=flat&colorA=18181B&colorB=28CF8D
87
+ [license-href]: https://npmjs.com/package/@pinegrow/astro-module
6
88
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pinegrow/astro-module",
3
- "version": "3.0.0-beta.111",
3
+ "version": "3.0.0-beta.113",
4
4
  "description": "Pinegrow Astro 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
- "astro-module"
23
+ "vue-designer",
24
+ "astro-module",
25
+ "@pinegrow/astro-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.113",
35
37
  "unplugin-vue-components": "^0.24.1",
36
38
  "unplugin-auto-import": "^0.15.2"
37
39
  },