docs: add readme

README.md

@@ -0,0 +1,38 @@
+<div align="center">
+  <a href="https://rattail.pages.dev">
+    <img src="https://rattail.pages.dev/logo.svg" width="150">
+  </a>
+  <h1>Rattail</h1>
+  <p>A utilities library for front-end developers, lightweight and ts-friendly.</p>
+  <p>
+    <a href="https://rattail.pages.dev">Documentation</a> |
+    <a href="https://github.com/varletjs/rattail/blob/main/README.zh-CN.md">中文介绍</a>
+  </p>
+</div>
+
+---
+
+### Features
+
+- 🛠️ &nbsp; Provide utilities frequently used in daily development
+- 🛠️ &nbsp; Utilities implementation is very lightweight
+- 🛠️ &nbsp; Written based on ts, providing complete ts types
+
+### Installation
+
+```shell
+# npm
+npm i rattail -S
+# yarn
+yarn add rattail
+# pnpm
+pnpm add rattail
+```
+
+### Usage
+
+```ts
+import { isString } from 'rattail'
+
+console.log(isString('rattail'))
+```

README.zh-CN.md

@@ -0,0 +1,38 @@
+<div align="center">
+  <a href="https://rattail.pages.dev/zh">
+    <img src="https://rattail.pages.dev/logo.svg" width="150">
+  </a>
+  <h1>Rattail</h1>
+  <p>面向前端开发人员的实用工具库，轻量级且 ts 友好</p>
+  <p>
+    <a href="https://rattail.pages.dev/zh">文档</a> |
+    <a href="https://github.com/varletjs/rattail/blob/main/README.md">ENGLISH README</a>
+  </p>
+</div>
+
+---
+
+### 特性
+
+- 🛠️ &nbsp; 提供日常开发中经常使用的实用工具
+- 🛠️ &nbsp; 工具实现非常轻量
+- 🛠️ &nbsp; 使用 ts 编写，提供完善的类型支持
+
+### 安装
+
+```shell
+# npm
+npm i rattail -S
+# yarn
+yarn add rattail
+# pnpm
+pnpm add rattail
+```
+
+### 使用
+
+```ts
+import { isString } from 'rattail'
+
+console.log(isString('rattail'))
+```

docs/zh/index.md

@@ -12,9 +12,9 @@ hero:
 
 features:
   - title: 通用
-    details: 提供日常开发中经常使用的实用程序
+    details: 提供日常开发中经常使用的实用工具
   - title: 轻量
     details: 工具实现非常轻量
   - title: Ts 友好
-    details: 实用 ts 编写，提供完善的类型支持
+    details: 使用 ts 编写，提供完善的类型支持
 ---