@zhangqingcq/vgce 0.0.11 → 0.0.13

package/README.md

@@ -1,2 +1,35 @@
 # VGCE
+
 Vector graphics configure editor. 矢量图组态编辑器。
+
+## Guide
+
+1. `npm i @zhangqingcq/vgce` or `pnpm add @zhangqingcq/vgce`
+
+2. `import '@zhangqingcq/vgce/style'` in main.ts
+
+3. editor
+
+```
+<script setup lang="ts">
+  import {SvgEditor} from '@zhangqingcq/vgce'
+  
+  function preview(d: any) {
+	  //save d and send it to SvgViewer's data 
+	}
+</script>
+<template>
+  <SvgEditor @onPreview="preview"/>
+</template>
+```
+
+4. viewer
+
+```
+<script setup lang="ts">
+  import {SvgViewer} from '@zhangqingcq/vgce'
+</script>
+<template>
+  <SvgViewer :data="xxx"/>
+</template>
+```