start up

vue-project/my-kintone-plugin/README.md

@@ -1,5 +1,15 @@
-# Vue 3 + Vite
+# My-kintone-plugin
 
-This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+1. 命令：
+   - `npm run build` 会将代码按照 kintone plugin 格式打包到 `dist`，并生成 `plugin.zip`
+   - `npm run upload` 会将 `plugin.zip` 上传到 kintone
 
-Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).
+2. 使用 Vue3.0 开发：
+   - 配置页面在 `components/Config.vue` 中开发
+   - Desktop 页面在 `js/desktop.ts` 中开发
+
+3. 关于组件：
+   - 使用了 https://ui-component.kintone.dev/ 组件库，但是它没有支持 Vue，所以需要作为 Web Component 来使用
+   - 又由于 Web Component 的格式是类似 `<kuc-button-1-18-0>`，为了开发方便能写成 `<kuc-button>`，手动进行了全局替换（见 `vite.config.js`）
+   - 同时也定死了 kintone-ui-component 版本号，更新版本号需要修改 `vite.config.js` 的插件
+   - 目前尚未实现 `<template>` 中组件的 ts 提示