update docs

Author: mozillazg

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.3.0 (yyyy-mm-dd)
+
+* fix "当字符串中有非中文的时候，会出现下标越界的情况"(影响 `pinyin.LazyPinyin` 和 `pinyin.Slug` ([#1](https://github.com/mozillazg/go-pinyin/issues/1))
+* 调整对非中文字符的处理：当遇到没有拼音的字符时，直接忽略
+  ```
+  // before
+  fmt.Println(pinyin.Pinyin("中国人abc", pinyin.NewArgs()))
+  [[zhong] [guo] [ren] [] [] []]
+
+  // after
+  fmt.Println(pinyin.Pinyin("中国人abc", pinyin.NewArgs()))
+  [[zhong] [guo] [ren]]
+  ```
+
+
 ## 0.2.1 (2015-08-26)
 
 * `yu`, `y`, `w` 不是声母

README.md

@@ -72,3 +72,4 @@ Related Projects
 
 * [hotoo/pinyin](https://github.com/hotoo/pinyin): 汉语拼音转换工具 Node.js/JavaScript 版。
 * [mozillazg/python-pinyin](https://github.com/mozillazg/python-pinyin): 汉语拼音转换工具 Python 版。
+* [mozillazg/rust-pinyin](https://github.com/mozillazg/rust-pinyin): 汉语拼音转换工具 Rust 版。

pinyin.go

@@ -15,26 +15,26 @@ const (
 
 // 拼音风格(推荐)
 const (
-	Normal      = 0 // 普通风格，不带声调（默认风格）。如： pin yin
-	Tone        = 1 // 声调风格1，拼音声调在韵母第一个字母上。如： pīn yīn
-	Tone2       = 2 // 声调风格2，即拼音声调在各个拼音之后，用数字 [0-4] 进行表示。如： pi1n yi1n
-	Initials    = 3 // 声母风格，只返回各个拼音的声母部分。如： 中国 的拼音 zh g
-	FirstLetter = 4 // 首字母风格，只返回拼音的首字母部分。如： p y
+	Normal      = 0 // 普通风格，不带声调（默认风格）。如： zhong guo
+	Tone        = 1 // 声调风格1，拼音声调在韵母第一个字母上。如： zhōng guó
+	Tone2       = 2 // 声调风格2，即拼音声调在各个拼音之后，用数字 [0-4] 进行表示。如： zho1ng guo2
+	Initials    = 3 // 声母风格，只返回各个拼音的声母部分。如： zh g
+	FirstLetter = 4 // 首字母风格，只返回拼音的首字母部分。如： z g
 	Finals      = 5 // 韵母风格1，只返回各个拼音的韵母部分，不带声调。如： ong uo
 	FinalsTone  = 6 // 韵母风格2，带声调，声调在韵母第一个字母上。如： ōng uó
 	FinalsTone2 = 7 // 韵母风格2，带声调，声调在各个拼音之后，用数字 [0-4] 进行表示。如： o1ng uo2
 )
 
 // 拼音风格(兼容之前的版本)
 const (
-	NORMAL       = 0 // 普通风格，不带声调（默认风格）。如： pin yin
-	TONE         = 1 // 声调风格1，拼音声调在韵母第一个字母上。如： pīn yīn
-	TONE2        = 2 // 声调风格2，即拼音声调在各个拼音之后，用数字 [0-4] 进行表示。如： pi1n yi1n
-	INITIALS     = 3 // 声母风格，只返回各个拼音的声母部分。如： 中国 的拼音 zh g
-	FIRST_LETTER = 4 // 首字母风格，只返回拼音的首字母部分。如： p y
-	FINALS       = 5 // 韵母风格1，只返回各个拼音的韵母部分，不带声调。如： ong uo
-	FINALS_TONE  = 6 // 韵母风格2，带声调，声调在韵母第一个字母上。如： ōng uó
-	FINALS_TONE2 = 7 // 韵母风格2，带声调，声调在各个拼音之后，用数字 [0-4] 进行表示。如： o1ng uo2
+	NORMAL       = Normal
+	TONE         = Tone
+	TONE2        = Tone2
+	INITIALS     = Initials
+	FIRST_LETTER = FirstLetter
+	FINALS       = Finals
+	FINALS_TONE  = FinalsTone
+	FINALS_TONE2 = FinalsTone2
 )
 
 // 声母表