docs: update docs

Author: coderwei99

README.md

@@ -1,20 +1,43 @@
 # coderwei-mini-vue3
 
-手写 vue3 核心源码，理解其原理 by myself
+手写 vue3 核心源码，理解其原理 by myself。
+
+项目包含大量注释，在核心且具有跳跃性的点进行了注释，站着阅读者的视角，特别是关联其他模块某个方法or用到其他
+方法处理的结果，在该位置备注处理函数名及函数位置。保证每个阅读者都能跟着流程走完能够在心里对vue的整个流程有大致的认知。
+
+无论是应付面试，还是希望通过有一个跷板进入vue3源码的世界，希望本项目都能够给到你帮助。项目还在持续更新中，力争完成vue的所有核心逻辑，进度在功能清单。如果有任何意见可以在issue中提出。
+
+## 🕳️ 声明
+项目是通过阅读[vue3](https://github.com/vuejs/core/tree/main)源码，函数名、代码组织方式都与vue3官方保持一致，抽离一切非vue的核心逻辑。**如果大家在阅读过程中发现任何问题，欢迎在issue中提出，同时也欢迎大家提交PR。当然如果在阅读过程中有什么疑惑，也欢迎在issue中提出。**
+
+## 🙌 使用方式
+
+项目采取monorepo结构，打包入口和打包出口已配置好，甚至包含我进行测试的example和打包后的文件，可以直接去/packages/vue/example直接运行index.html文件
+
+当然也可以选择自己打包
+~~~shell
+  npm run build
+  yarn build
+  pnpm run build
+  nr build 
+~~~
+## 🗯️ 插件
+1. 这里推荐大家使用[ni](https://github.com/antfu/ni)
+
+2. 在运行index.html文件的时候同样推荐大家安装vscode插件[Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer)
+
 
-## 🙌 目的
-我想进大厂
 
 ## ✏ 相关参考
-[Vue3 核心原理代码解构](https://juejin.cn/column/7089244418703622175)
+1. [Vue3 核心原理代码解构](https://juejin.cn/column/7089244418703622175)
 
-[崔学社](https://github.com/cuixiaorui/mini-vue)
+2. [崔学社](https://github.com/cuixiaorui/mini-vue)
 
-[Vue.js 的设计与实现](https://item.jd.com/13611922.html)
+3. [Vue.js 的设计与实现](https://item.jd.com/13611922.html)
 
 ## 🛠 功能清单
 
-reactivity 部分
+### reactivity 部分
 - [x] 实现 effect & reactive 依赖收集和依赖触发
 - [x] 实现 effect 返回 runner
 - [x] 实现 effect 的 scheduler 功能
@@ -34,7 +57,7 @@ reactivity 部分
 - [x] 实现 toRef 功能
 - [x] 实现 toRefs 功能
 
-runtime-core 部分
+### runtime-core 部分
 - [x] 实现初始化 component 主流程
 - [x] 实现初始化 element 主流程 （通过递归 patch 拆箱操作，最终都会走向 mountElement 这一步）
 - [x] 实现组件代理对象 （instance.proxy 解决`render()`函数的 this 指向问题）
@@ -68,23 +91,40 @@ runtime-core 部分
 - [ ] 实现 Suspense 组件
 - [x] 实现 vue3的生命周期
 
-runtime-dom
+### runtime-dom
 - [x] 实现浏览器端的渲染逻辑(插入节点、删除节点、更新节点等等)
 - [ ] 实现 Transition 组件
 - [ ] 实现 TransitionGroup 组件
 
-compiler-core 部分
+### compiler-core 部分
 - [x] 实现 parse 模块
 - [x] 实现 transform 模块
 - [x] 实现 codegen 模块
 - [x] 定义统一的出口(定义 baseCompiler 函数)
 
-兼容vue2部分
+### 兼容vue2部分
 - [ ] 兼容options api
 - [ ] 兼容vue2的生命周期 (beforeCreate、created等)
 
+### 内置指令
+- [ ] v-text 
+- [ ] v-html
+- [ ] v-show
+- [ ] v-if
+- [ ] v-else
+- [ ] v-else-if
+- [ ] v-for
+- [ ] v-on
+- [ ] v-bind
+- [ ] v-model
+- [ ] v-slot
+- [ ] v-pre
+- [ ] v-once
+- [ ] v-memo
+- [ ] v-cloak
+
 
-monorepo
+### monorepo
 - [x] 使用monorepo重构整个项目
 - [x] 使用vitest进行TDD测试