Release 2.11.0

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ----
 
+## 2.11.0 (2022-02-25)
+
+- feat(surname): 支持姓氏拼音模式，优先处理姓氏读音。 fixed #288
+
 ## 2.10.2 (2021-04-11)
 
 - feat(cli): pinyin cli support group by phrases.

README.en-US.md

@@ -122,6 +122,11 @@ wǒ xǐhuān nǐ
 Specify pinyin style. please use static properties like `STYLE_*`.
 default is `.STYLE_TONE`. see Static Property for more.
 
+### `options.mode`
+
+pinyin mode, default is `pinyin.MODE_NORMAL`. If you cleared in surname scene,
+use `pinyin.MODE_SURNAME` maybe better.
+
 ## Static Property
 
 ### `.STYLE_NORMAL`
@@ -162,6 +167,13 @@ First letter style.
 
 Example: `p y`
 
+### `pinyin.MODE_NORMAL`
+
+Normal mode. This is the default mode.
+
+### `pinyin.MODE_SURNAME`
+
+Surname mode. If chinese word is surname, The pinyin of surname is prioritized.
 
 ## Test
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pinyin",
-  "version": "2.10.2",
+  "version": "2.11.0",
   "description": "汉语拼音转换工具。",
   "files": [
     "bin",