From 690e746811b007b70782e4c12deb74dee3919d7a Mon Sep 17 00:00:00 2001 From: dudaodong Date: Fri, 29 Apr 2022 14:50:29 +0800 Subject: [PATCH] update readme file --- README.md | 28 ++++++++++++++-------------- README_zh-CN.md | 26 +++++++++++++------------- 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 5e0137d..68117e7 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ English | [简体中文](./README_zh-CN.md) ## Feature - 👏 Comprehensive, efficient and reusable. -- 💪 180+ go util functions, support string, slice, datetime, net, crypt... +- 💪 200+ go util functions, support string, slice, datetime, net, crypt... - 💅 Only depend on the go standard library. - 🌍 Unit test for every exported function. @@ -62,7 +62,7 @@ func main() { ``` ## API Documentation -### Convertor package contains some functions for data convertion. +### 1. Convertor package contains some functions for data convertion. ```go import "github.com/duke-git/lancet/convertor" @@ -78,7 +78,7 @@ import "github.com/duke-git/lancet/convertor" - [ToString](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToString) - [StructToMap](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#StructToMap) -### Cryptor package is for data encryption and decryption. +### 2. Cryptor package is for data encryption and decryption. ```go import "github.com/duke-git/lancet/cryptor" @@ -118,7 +118,7 @@ import "github.com/duke-git/lancet/cryptor" - [RsaEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#RsaEncrypt) - [RsaDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#RsaDecrypt) -### Datetime package supports date and time format and compare. +### 3. Datetime package supports date and time format and compare. ```go @@ -156,7 +156,7 @@ import "github.com/duke-git/lancet/datetime" - [ToFormatForTpl](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToFormatForTpl) - [ToIso8601](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToIso8601) -### Fileutil package implements some basic functions for file operations. +### 4. Fileutil package implements some basic functions for file operations. ```go import "github.com/duke-git/lancet/fileutil" @@ -179,7 +179,7 @@ import "github.com/duke-git/lancet/fileutil" - [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Zip) - [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#UnZip) -### Formatter contains some functions for data formatting. +### 5. Formatter contains some functions for data formatting. ```go import "github.com/duke-git/lancet/formatter" @@ -203,7 +203,7 @@ import "github.com/duke-git/lancet/function" - [Watcher](https://github.com/duke-git/lancet/blob/main/docs/function.md#Watcher) -### Mathutil package implements some functions for math calculation. +### 6. Mathutil package implements some functions for math calculation. ```go import "github.com/duke-git/lancet/mathutil" @@ -219,7 +219,7 @@ import "github.com/duke-git/lancet/mathutil" - [TruncRound](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#TruncRound) -### Netutil package contains functions to get net information and send http request. +### 7. Netutil package contains functions to get net information and send http request. ```go import "github.com/duke-git/lancet/netutil" @@ -239,7 +239,7 @@ import "github.com/duke-git/lancet/netutil" - [HttpPatch](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPatch) - [ParseHttpResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#ParseHttpResponse) -### Random package implements some basic functions to generate random int and string. +### 8. Random package implements some basic functions to generate random int and string. ```go import "github.com/duke-git/lancet/random" @@ -251,7 +251,7 @@ import "github.com/duke-git/lancet/random" - [RandString](https://github.com/duke-git/lancet/blob/main/docs/random.md#RandString) - [UUIdV4](https://github.com/duke-git/lancet/blob/main/docs/random.md#UUIdV4) -### Retry package is for executing a function repeatedly until it was successful or canceled by the context. +### 9. Retry package is for executing a function repeatedly until it was successful or canceled by the context. ```go import "github.com/duke-git/lancet/retry" @@ -264,7 +264,7 @@ import "github.com/duke-git/lancet/retry" - [RetryDuration](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryDuration) - [RetryTimes](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryTimes) -### Slice contains some functions to manipulate slice. +### 10. Slice contains some functions to manipulate slice. ```go import "github.com/duke-git/lancet/slice" @@ -304,7 +304,7 @@ import "github.com/duke-git/lancet/slice" - [UpdateByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice.md#UpdateByIndex) - [Without](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Without) -### Strutil package contains some functions to manipulate string. +### 11. Strutil package contains some functions to manipulate string. ```go import "github.com/duke-git/lancet/strutil" @@ -329,7 +329,7 @@ import "github.com/duke-git/lancet/strutil" - [Wrap](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Wrap) - [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Unwrap) -### System package contain some functions about os, runtime, shell command. +### 12. System package contain some functions about os, runtime, shell command. ```go import "github.com/duke-git/lancet/system" @@ -345,7 +345,7 @@ import "github.com/duke-git/lancet/system" - [CompareOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system.md#CompareOsEnv) - [ExecCommand](https://github.com/duke-git/lancet/blob/main/docs/system.md#ExecCommand) -### Validator package contains some functions for data validation. +### 13. Validator package contains some functions for data validation. ```go import "github.com/duke-git/lancet/validator" diff --git a/README_zh-CN.md b/README_zh-CN.md index d3dd84a..0cbe584 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -62,7 +62,7 @@ func main() { ``` ## API文档 -### convertor转换器包支持一些常见的数据类型转换。 +### 1. convertor转换器包支持一些常见的数据类型转换。 ```go import "github.com/duke-git/lancet/convertor" @@ -78,7 +78,7 @@ import "github.com/duke-git/lancet/convertor" - [ToString](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToString) - [StructToMap](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#StructToMap) -### cryptor加密包支持数据加密和解密,获取md5,hash值。支持base64, md5, hmac, aes, des, rsa。 +### 2. cryptor加密包支持数据加密和解密,获取md5,hash值。支持base64, md5, hmac, aes, des, rsa。 ```go import "github.com/duke-git/lancet/cryptor" @@ -118,7 +118,7 @@ import "github.com/duke-git/lancet/cryptor" - [RsaEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#RsaEncrypt) - [RsaDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#RsaDecrypt) -### datetime日期时间处理包,格式化日期,比较日期。 +### 3. datetime日期时间处理包,格式化日期,比较日期。 ```go @@ -155,7 +155,7 @@ import "github.com/duke-git/lancet/datetime" - [ToFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToFormat) - [ToFormatForTpl](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToFormatForTpl) - [ToIso8601](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToIso8601) -### fileutil包支持文件基本操作。 +### 4. fileutil包支持文件基本操作。 ```go import "github.com/duke-git/lancet/fileutil" @@ -178,7 +178,7 @@ import "github.com/duke-git/lancet/fileutil" - [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#Zip) - [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#UnZip) -### formatter格式化器包含一些数据格式化处理方法。 +### 5. formatter格式化器包含一些数据格式化处理方法。 ```go import "github.com/duke-git/lancet/formatter" @@ -202,7 +202,7 @@ import "github.com/duke-git/lancet/function" - [Delay](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Delay) - [Watcher](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Watcher) -### mathutil包实现了一些数学计算的函数。 +### 6. mathutil包实现了一些数学计算的函数。 ```go import "github.com/duke-git/lancet/mathutil" @@ -217,7 +217,7 @@ import "github.com/duke-git/lancet/mathutil" - [RoundToString](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RoundToString) - [TruncRound](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#TruncRound) -### netutil网络包支持获取ip地址,发送http请求。 +### 7. netutil网络包支持获取ip地址,发送http请求。 ```go import "github.com/duke-git/lancet/netutil" @@ -237,7 +237,7 @@ import "github.com/duke-git/lancet/netutil" - [HttpPatch](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPatch) - [ParseHttpResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#ParseHttpResponse) -### random随机数生成器包,可以生成随机[]bytes, int, string。 +### 8. random随机数生成器包,可以生成随机[]bytes, int, string。 ```go import "github.com/duke-git/lancet/random" @@ -248,7 +248,7 @@ import "github.com/duke-git/lancet/random" - [RandInt](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#RandInt) - [RandString](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#RandString) - [UUIdV4](https://github.com/duke-git/lancet/blob/main/docs/random.md#UUIdV4) -### retry重试执行函数直到函数运行成功或被context cancel。 +### 9. retry重试执行函数直到函数运行成功或被context cancel。 ```go import "github.com/duke-git/lancet/retry" @@ -262,7 +262,7 @@ import "github.com/duke-git/lancet/retry" - [RetryTimes](https://github.com/duke-git/lancet/blob/main/docs/retry_zh-CN.md#RetryTimes) -### slice包包含操作切片的方法集合。 +### 10. slice包包含操作切片的方法集合。 ```go import "github.com/duke-git/lancet/slice" @@ -303,7 +303,7 @@ import "github.com/duke-git/lancet/slice" - [Without](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Without) -### strutil包含处理字符串的相关函数。 +### 12. strutil包含处理字符串的相关函数。 ```go import "github.com/duke-git/lancet/strutil" @@ -329,7 +329,7 @@ import "github.com/duke-git/lancet/strutil" - [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#Unwrap) -### system包含os, runtime, shell command相关函数。 +### 13. system包含os, runtime, shell command相关函数。 ```go import "github.com/duke-git/lancet/system" @@ -345,7 +345,7 @@ import "github.com/duke-git/lancet/system" - [CompareOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#CompareOsEnv) - [ExecCommand](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#ExecCommand) -### validator验证器包,包含常用字符串格式验证函数。 +### 14. validator验证器包,包含常用字符串格式验证函数。 ```go import "github.com/duke-git/lancet/validator"