docs: add description

README.md

@@ -1,7 +1,25 @@
 # IbPinyinLib
 [![License](https://img.shields.io/crates/l/ib-pinyin.svg)](LICENSE.txt)
 
-## 语言
+一个高性能 Rust 拼音匹配库。
+
+- 支持以下拼音编码方案：
+  - 简拼（“py”）
+  - 全拼（“pinyin”）
+  - 带声调全拼（“pin1yin1”）
+  - Unicode（“pīnyīn”）
+  - 智能 ABC 双拼
+  - 拼音加加双拼
+  - 微软双拼
+  - 华宇双拼（紫光双拼）
+  - 小鹤双拼
+  - 自然码双拼
+- 支持多音字。
+- 支持混合匹配多种拼音编码方案，默认匹配简拼和全拼。
+- 默认小写字母匹配拼音或字母，大写字母只匹配字母。
+- 支持 Unicode 辅助平面汉字。
+
+## 支持语言
 ### [Rust](src/README.md)
 [![crates.io](https://img.shields.io/crates/v/ib-pinyin.svg)](https://crates.io/crates/ib-pinyin)
 [![Documentation](https://docs.rs/ib-pinyin/badge.svg)](https://docs.rs/ib-pinyin)
@@ -46,8 +64,4 @@ IsMatch := IbPinyin_IsMatch("pysousuoeve", "拼音搜索Everything", IbPinyin_As
 
 ## 相关项目
 - [IbEverythingExt: Everything 拼音搜索、快速选择扩展](https://github.com/Chaoses-Ib/IbEverythingExt)
-- [pinyin-data: 汉字拼音数据](https://github.com/Chaoses-Ib/pinyin-data)
-
-其它拼音库：
-- [rust-pinyin: 汉字转拼音](https://github.com/mozillazg/rust-pinyin)
-- [samlink/rust-pinyin: Chinese pinyin initials in rust](https://github.com/samlink/rust_pinyin)
+- [pinyin-data: 汉字拼音数据](https://github.com/Chaoses-Ib/pinyin-data)

bindings/ahk2/README.md

@@ -8,5 +8,17 @@ Binding for [AutoHotkey](https://www.autohotkey.com/) v2.
 IsMatch := IbPinyin_IsMatch("pysousuoeve", "拼音搜索Everything", IbPinyin_AsciiFirstLetter | IbPinyin_Ascii)
 
 是否匹配 := 拼音_匹配("pysousuoeve", "拼音搜索Everything")
+
+; 拼音_简拼
+; 拼音_全拼
+; 拼音_带声调全拼
+; 拼音_Unicode
+; 拼音_智能ABC双拼
+; 拼音_拼音加加双拼
+; 拼音_微软双拼
+; 拼音_华宇双拼
+; 拼音_紫光双拼
+; 拼音_小鹤双拼
+; 拼音_自然码双拼
 是否匹配 := 拼音_匹配("pysousuoeve", "拼音搜索Everything", 拼音_简拼 | 拼音_全拼)
 ```

src/README.md

@@ -16,4 +16,8 @@ assert!(matcher.is_match("拼音搜索Everything"));
 ## Testing
 ```sh
 cargo hack test --feature-powerset
-```
+```
+
+## See also
+- [rust-pinyin: 汉字转拼音](https://github.com/mozillazg/rust-pinyin)
+- [samlink/rust-pinyin: Chinese pinyin initials in rust](https://github.com/samlink/rust_pinyin)