Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mozillazg authored and huacnlee committed Jul 28, 2022
1 parent 7073185 commit d9fd47a
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 22 deletions.
47 changes: 26 additions & 21 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## [0.18.0] (2020-mm-dd)
* **Changed** 使用 [pinyin-data][pinyin-data] v0.9.0 的拼音数据
* **Bugfixed** 修复自定义的 Fallback 函数可能会导致结果乱码的问题 Fixes [#35]

## [0.17.0] (2020-04-09)

Expand Down Expand Up @@ -192,24 +193,28 @@
[pinyin-data]: https://github.com/mozillazg/pinyin-data
[@wdscxsj]: https://github.com/wdscxsj
[@huacnlee]: https://github.com/huacnlee
[#19]: https://github.com/longbridgeapp/go-pinyin/pull/19
[#20]: https://github.com/longbridgeapp/go-pinyin/pull/20
[#30]: https://github.com/longbridgeapp/go-pinyin/pull/30
[#37]: https://github.com/longbridgeapp/go-pinyin/pull/37
[0.1.1]: https://github.com/longbridgeapp/go-pinyin/compare/v0.1.0...v0.1.1
[0.2.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.1.1...v0.2.0
[0.2.1]: https://github.com/longbridgeapp/go-pinyin/compare/v0.2.0...v0.2.1
[0.3.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.2.1...v0.3.0
[0.4.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.3.0...v0.4.0
[0.5.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.4.0...v0.5.0
[0.6.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.5.0...v0.6.0
[0.7.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.6.0...v0.7.0
[0.8.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.7.0...v0.8.0
[0.9.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.8.0...v0.9.0
[0.10.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.9.0...v0.10.0
[0.11.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.10.0...v0.11.0
[0.12.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.11.0...v0.12.0
[0.13.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.12.0...v0.13.0
[0.14.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.13.0...v0.14.0
[0.15.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.14.0...v0.15.0
[0.16.0]: https://github.com/longbridgeapp/go-pinyin/compare/v0.15.0...v0.16.0
[#19]: https://github.com/mozillazg/go-pinyin/pull/19
[#20]: https://github.com/mozillazg/go-pinyin/pull/20
[#30]: https://github.com/mozillazg/go-pinyin/pull/30
[#37]: https://github.com/mozillazg/go-pinyin/pull/37
[#35]: https://github.com/mozillazg/go-pinyin/issues/35

[0.1.1]: https://github.com/mozillazg/go-pinyin/compare/v0.1.0...v0.1.1
[0.2.0]: https://github.com/mozillazg/go-pinyin/compare/v0.1.1...v0.2.0
[0.2.1]: https://github.com/mozillazg/go-pinyin/compare/v0.2.0...v0.2.1
[0.3.0]: https://github.com/mozillazg/go-pinyin/compare/v0.2.1...v0.3.0
[0.4.0]: https://github.com/mozillazg/go-pinyin/compare/v0.3.0...v0.4.0
[0.5.0]: https://github.com/mozillazg/go-pinyin/compare/v0.4.0...v0.5.0
[0.6.0]: https://github.com/mozillazg/go-pinyin/compare/v0.5.0...v0.6.0
[0.7.0]: https://github.com/mozillazg/go-pinyin/compare/v0.6.0...v0.7.0
[0.8.0]: https://github.com/mozillazg/go-pinyin/compare/v0.7.0...v0.8.0
[0.9.0]: https://github.com/mozillazg/go-pinyin/compare/v0.8.0...v0.9.0
[0.10.0]: https://github.com/mozillazg/go-pinyin/compare/v0.9.0...v0.10.0
[0.11.0]: https://github.com/mozillazg/go-pinyin/compare/v0.10.0...v0.11.0
[0.12.0]: https://github.com/mozillazg/go-pinyin/compare/v0.11.0...v0.12.0
[0.13.0]: https://github.com/mozillazg/go-pinyin/compare/v0.12.0...v0.13.0
[0.14.0]: https://github.com/mozillazg/go-pinyin/compare/v0.13.0...v0.14.0
[0.15.0]: https://github.com/mozillazg/go-pinyin/compare/v0.14.0...v0.15.0
[0.16.0]: https://github.com/mozillazg/go-pinyin/compare/v0.15.0...v0.16.0
[0.17.0]: https://github.com/mozillazg/go-pinyin/compare/v0.16.0...v0.17.0

8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ func main() {
}
```

注意:

* 默认情况下会忽略没有拼音的字符(可以通过自定义 `Fallback` 参数的值来自定义如何处理没有拼音的字符,
详见 [示例](https://godoc.org/github.com/mozillazg/go-pinyin#example-Pinyin--FallbackCustom1))。
* 根据 [《汉语拼音方案》](http://www.moe.gov.cn/s78/A19/yxs_left/moe_810/s230/195802/t19580201_186000.html) y,w,ü (yu) 都不是声母,
以及不是所有拼音都有什么,如果这不是你预期的话,你可能需要的是首字母风格 `FirstLetter`
[详细信息](https://github.com/mozillazg/python-pinyin#%E4%B8%BA%E4%BB%80%E4%B9%88%E6%B2%A1%E6%9C%89-y-w-yu-%E5%87%A0%E4%B8%AA%E5%A3%B0%E6%AF%8D) )。

## Related Projects

- [hotoo/pinyin](https://github.com/hotoo/pinyin): 汉语拼音转换工具 Node.js/JavaScript 版。
Expand Down
2 changes: 1 addition & 1 deletion pinyin.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const (
Tone = 1 // 声调风格1,拼音声调在韵母第一个字母上。如: zhōng guó
Tone2 = 2 // 声调风格2,即拼音声调在各个韵母之后,用数字 [1-4] 进行表示。如: zho1ng guo2
Tone3 = 8 // 声调风格3,即拼音声调在各个拼音之后,用数字 [1-4] 进行表示。如: zhong1 guo2
Initials = 3 // 声母风格,只返回各个拼音的声母部分。如: zh g
Initials = 3 // 声母风格,只返回各个拼音的声母部分。如: zh g 。注意:不是所有的拼音都有声母
FirstLetter = 4 // 首字母风格,只返回拼音的首字母部分。如: z g
Finals = 5 // 韵母风格,只返回各个拼音的韵母部分,不带声调。如: ong uo
FinalsTone = 6 // 韵母风格1,带声调,声调在韵母第一个字母上。如: ōng uó
Expand Down

0 comments on commit d9fd47a

Please sign in to comment.