docs: update doc for random package

docs/random.md

@@ -1,4 +1,5 @@
 # Random
+
 Package random implements some basic functions to generate random int and string.
 
 <div STYLE="page-break-after: always;"></div>
@@ -7,10 +8,10 @@ Package random implements some basic functions to generate random int and string
 
 [https://github.com/duke-git/lancet/blob/v1/random/random.go](https://github.com/duke-git/lancet/blob/v1/random/random.go)
 
-
 <div STYLE="page-break-after: always;"></div>
 
 ## Usage:
+
 ```go
 import (
     "github.com/duke-git/lancet/random"
@@ -20,17 +21,23 @@ import (
 <div STYLE="page-break-after: always;"></div>
 
 ## Index
-- [RandBytes](#RandBytes)
-- [RandInt](#RandInt)
-- [RandString](#RandString)
-- [UUIdV4](#UUIdV4)
+
+-   [RandBytes](#RandBytes)
+-   [RandInt](#RandInt)
+-   [RandString](#RandString)
+-   [RandUpper](#RandUpper)
+
+-   [RandLower](#RandLower)
+-   [RandNumeral](#RandNumeral)
+-   [RandNumeralOrLetter](#RandNumeralOrLetter)
+-   [UUIdV4](#UUIdV4)
 
 <div STYLE="page-break-after: always;"></div>
 
 ## Documentation
 
-
 ### <span id="RandBytes">RandBytes</span>
+
 <p>Generate random byte slice.</p>
 
 <b>Signature:</b>
@@ -38,6 +45,7 @@ import (
 ```go
 func RandBytes(length int) []byte
 ```
+
 <b>Example:</b>
 
 ```go
@@ -54,8 +62,8 @@ func main() {
 }
 ```
 
-
 ### <span id="RandInt">RandInt</span>
+
 <p>Generate random int between min and max, may contain min, not max.</p>
 
 <b>Signature:</b>
@@ -63,6 +71,7 @@ func main() {
 ```go
 func RandInt(min, max int) int
 ```
+
 <b>Example:</b>
 
 ```go
@@ -79,16 +88,16 @@ func main() {
 }
 ```
 
+### <span id="RandString">RandString</span>
 
-
-### <span id="RandString">RandInt</span>
-<p>Generate random given length string.</p>
+<p>Generate random given length string. only contains letter (a-zA-Z)</p>
 
 <b>Signature:</b>
 
 ```go
 func RandString(length int) string
 ```
+
 <b>Example:</b>
 
 ```go
@@ -101,14 +110,116 @@ import (
 
 func main() {
 	randStr := random.RandString(6)
-	fmt.Println(randStr)
+	fmt.Println(randStr) //pGWsze
 }
 ```
 
+### <span id="RandUpper">RandUpper</span>
 
+<p>Generate a random upper case string</p>
 
+<b>Signature:</b>
+
+```go
+func RandUpper(length int) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/random"
+)
+
+func main() {
+	randStr := random.RandString(6)
+	fmt.Println(randStr) //PACWGF
+}
+```
+
+### <span id="RandLower">RandLower</span>
+
+<p>Generate a random lower case string</p>
+
+<b>Signature:</b>
+
+```go
+func RandLower(length int) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/random"
+)
+
+func main() {
+	randStr := random.RandLower(6)
+	fmt.Println(randStr) //siqbew
+}
+```
+
+### <span id="RandNumeral">RandNumeral</span>
+
+<p>Generate a random numeral string</p>
+
+<b>Signature:</b>
+
+```go
+func RandNumeral(length int) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/random"
+)
+
+func main() {
+	randStr := random.RandNumeral(6)
+	fmt.Println(randStr) //035172
+}
+```
+
+### <span id="RandNumeralOrLetter">RandNumeralOrLetter</span>
+
+<p>generate a random numeral or letter string</p>
+
+<b>Signature:</b>
+
+```go
+func RandNumeralOrLetter(length int) string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/random"
+)
+
+func main() {
+	randStr := random.RandNumeralOrLetter(6)
+	fmt.Println(randStr) //0aW7cQ
+}
+```
 
 ### <span id="UUIdV4">UUIdV4</span>
+
 <p>Generate a random UUID of version 4 according to RFC 4122.</p>
 
 <b>Signature:</b>
@@ -116,6 +227,7 @@ func main() {
 ```go
 func UUIdV4() (string, error)
 ```
+
 <b>Example:</b>
 
 ```go
@@ -134,5 +246,3 @@ func main() {
 	fmt.Println(uuid)
 }
 ```
-
-

docs/random_zh-CN.md

@@ -1,5 +1,6 @@
 # Random
-random随机数生成器包，可以生成随机[]bytes, int, string。
+
+random 随机数生成器包，可以生成随机[]bytes, int, string。
 
 <div STYLE="page-break-after: always;"></div>
 
@@ -7,10 +8,10 @@ random随机数生成器包，可以生成随机[]bytes, int, string。
 
 [https://github.com/duke-git/lancet/blob/v1/random/random.go](https://github.com/duke-git/lancet/blob/v1/random/random.go)
 
-
 <div STYLE="page-break-after: always;"></div>
 
 ## 用法:
+
 ```go
 import (
     "github.com/duke-git/lancet/random"
@@ -20,18 +21,23 @@ import (
 <div STYLE="page-break-after: always;"></div>
 
 ## 目录
-- [RandBytes](#RandBytes)
-- [RandInt](#RandInt)
-- [RandString](#RandString)
-- [UUIdV4](#UUIdV4)
 
+-   [RandBytes](#RandBytes)
+-   [RandInt](#RandInt)
+-   [RandString](#RandString)
+-   [RandUpper](#RandUpper)
+
+-   [RandLower](#RandLower)
+-   [RandNumeral](#RandNumeral)
+-   [RandNumeralOrLetter](#RandNumeralOrLetter)
+-   [UUIdV4](#UUIdV4)
 
 <div STYLE="page-break-after: always;"></div>
 
 ## 文档
 
-
 ### <span id="RandBytes">RandBytes</span>
+
 <p>生成随机字节切片</p>
 
 <b>函数签名:</b>
@@ -39,6 +45,7 @@ import (
 ```go
 func RandBytes(length int) []byte
 ```
+
 <b>例子:</b>
 
 ```go
@@ -55,8 +62,8 @@ func main() {
 }
 ```
 
-
 ### <span id="RandInt">RandInt</span>
+
 <p>生成随机int, 范围[min, max)</p>
 
 <b>函数签名:</b>
@@ -64,6 +71,7 @@ func main() {
 ```go
 func RandInt(min, max int) int
 ```
+
 <b>例子:</b>
 
 ```go
@@ -80,16 +88,16 @@ func main() {
 }
 ```
 
+### <span id="RandString">RandString</span>
 
-
-### <span id="RandString">RandInt</span>
-<p>生成随机给定长度的随机字符串</p>
+<p>生成给定长度的随机字符串，只包含字母(a-zA-Z)</p>
 
 <b>函数签名:</b>
 
 ```go
 func RandString(length int) string
 ```
+
 <b>例子:</b>
 
 ```go
@@ -102,13 +110,116 @@ import (
 
 func main() {
 	randStr := random.RandString(6)
-	fmt.Println(randStr)
+	fmt.Println(randStr) //pGWsze
 }
 ```
 
+### <span id="RandUpper">RandUpper</span>
 
+<p>生成给定长度的随机大写字母字符串</p>
+
+<b>函数签名:</b>
+
+```go
+func RandUpper(length int) string
+```
+
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/random"
+)
+
+func main() {
+	randStr := random.RandString(6)
+	fmt.Println(randStr) //PACWGF
+}
+```
+
+### <span id="RandLower">RandLower</span>
+
+<p>生成给定长度的随机小写字母字符串</p>
+
+<b>函数签名:</b>
+
+```go
+func RandLower(length int) string
+```
+
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/random"
+)
+
+func main() {
+	randStr := random.RandLower(6)
+	fmt.Println(randStr) //siqbew
+}
+```
+
+### <span id="RandNumeral">RandNumeral</span>
+
+<p>生成给定长度的随机数字字符串</p>
+
+<b>函数签名:</b>
+
+```go
+func RandNumeral(length int) string
+```
+
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/random"
+)
+
+func main() {
+	randStr := random.RandNumeral(6)
+	fmt.Println(randStr) //035172
+}
+```
+
+### <span id="RandNumeralOrLetter">RandNumeralOrLetter</span>
+
+<p>生成给定长度的随机字符串（数字+字母)</p>
+
+<b>函数签名:</b>
+
+```go
+func RandNumeralOrLetter(length int) string
+```
+
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/random"
+)
+
+func main() {
+	randStr := random.RandNumeralOrLetter(6)
+	fmt.Println(randStr) //0aW7cQ
+}
+```
 
 ### <span id="UUIdV4">UUIdV4</span>
+
 <p>生成UUID v4字符串</p>
 
 <b>函数签名:</b>
@@ -116,6 +227,7 @@ func main() {
 ```go
 func UUIdV4() (string, error)
 ```
+
 <b>例子:</b>
 
 ```go
@@ -134,5 +246,3 @@ func main() {
 	fmt.Println(uuid)
 }
 ```
-
-