docs: add readme

Author: linzhe141

README.md

@@ -1,5 +1,27 @@
-# Vue 3 + TypeScript + Vite
+# vue-change-marker
+When a vue component changes, vue-change-marker can highlight the changed component
 
-This template should help get you started developing with Vue 3 and TypeScript 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.
+[demo](https://linzhe141.github.io/vue-change-marker/)
 
-Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
+![vue-change-marker demo](./demo.gif)
+
+> [!IMPORTANT]
+> Only works in the dev environment
+
+## Install
+
+```bash
+npm i vue-change-marker
+```
+
+
+
+```ts
+import { VueChangeMarker } from 'vue-change-marker'
+import { createApp } from 'vue'
+import App from './App.vue'
+// Before createApp
+VueChangeMarker()
+
+createApp(App).mount('#app')
+```