diff --git a/README.md b/README.md new file mode 100644 index 0000000..292aa8b --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +
+ + + +

Rattail

+

A utilities library for front-end developers, lightweight and ts-friendly.

+

+ Documentation | + 中文介绍 +

+
+ +--- + +### Features + +- 🛠️   Provide utilities frequently used in daily development +- 🛠️   Utilities implementation is very lightweight +- 🛠️   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')) +``` diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..a60e19e --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,38 @@ +
+ + + +

Rattail

+

面向前端开发人员的实用工具库,轻量级且 ts 友好

+

+ 文档 | + ENGLISH README +

+
+ +--- + +### 特性 + +- 🛠️   提供日常开发中经常使用的实用工具 +- 🛠️   工具实现非常轻量 +- 🛠️   使用 ts 编写,提供完善的类型支持 + +### 安装 + +```shell +# npm +npm i rattail -S +# yarn +yarn add rattail +# pnpm +pnpm add rattail +``` + +### 使用 + +```ts +import { isString } from 'rattail' + +console.log(isString('rattail')) +``` diff --git a/docs/zh/index.md b/docs/zh/index.md index eca1aae..10378a1 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -12,9 +12,9 @@ hero: features: - title: 通用 - details: 提供日常开发中经常使用的实用程序 + details: 提供日常开发中经常使用的实用工具 - title: 轻量 details: 工具实现非常轻量 - title: Ts 友好 - details: 实用 ts 编写,提供完善的类型支持 + details: 使用 ts 编写,提供完善的类型支持 ---