From ef55737c95c5c619b905d4050f1e717429a2464f Mon Sep 17 00:00:00 2001
From: yutent <yutent.io@gmail.com>
Date: Mon, 25 Sep 2023 15:55:58 +0800
Subject: [PATCH] Add Router

---
 Router.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 Router.md

diff --git a/Router.md b/Router.md
new file mode 100644
index 0000000..2e2e7ef
--- /dev/null
+++ b/Router.md
@@ -0,0 +1,24 @@
+# 路由
+> 仿`vue-router`的API,实现一套简化版的路由模块。可支持传统的`hash`路由, 以及新的`history`路由。
+>> **注意:** 由于`web components`的限制, 不支持嵌套路由。
+
+
+```js
+
+import { createRouter, createWebHistory } from 'wkitd'
+
+const router = createRouter({
+  history: createWebHistory(), // 默认createWebHashHistory
+  routes: [
+    {
+      path: '/',
+      name: 'wc-home' // 必须为页面组件的标签名
+    },
+    {
+      path: '/about',
+      name: 'wc-about',
+      component: () => import('./views/about.js')
+    }
+  ]
+})
+```