1
0
mirror of https://github.com/duke-git/lancet.git synced 2026-03-01 00:35:28 +08:00

docs: add v2 in import path

This commit is contained in:
dudaodong
2022-03-17 11:33:45 +08:00
parent 50c6e51393
commit 40b2560752
34 changed files with 497 additions and 497 deletions

View File

@@ -5,8 +5,8 @@
![Go version](https://img.shields.io/badge/go-%3E%3D1.16<recommend>-9cf)
[![Release](https://img.shields.io/badge/release-2.0.0-green.svg)](https://github.com/duke-git/lancet/releases)
[![GoDoc](https://godoc.org/github.com//duke-git/lancet?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet)
[![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet)](https://goreportcard.com/report/github.com/duke-git/lancet)
[![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
[![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
[![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
[![codecov](https://codecov.io/gh/duke-git/lancet/branch/main/graph/badge.svg?token=FC48T1F078)](https://codecov.io/gh/duke-git/lancet)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/duke-git/lancet/blob/main/LICENSE)
@@ -30,10 +30,10 @@
## 安装
### Note:
1. <b>对于使用go1.18及以上的用户,建议安装lancet v2.x.x。 因为v2.x.x用go1.18的泛型重写了所有函数。 默认安装将是最新版本的v2.x.x</b>
1. <b>对于使用go1.18及以上的用户建议安装v2.x.x。 因为v2.x.x用go1.18的泛型重写了大部分函数。</b>
```go
go get github.com/duke-git/lancet //默认安装v2最新版本v2.x.x
go get github.com/duke-git/lancet/v2 //安装v2最新版本v2.x.x
```
2. <b>使用go1.18以下版本的用户必须安装v1.x.x。目前最新的v1版本是v1.2.6。</b>
@@ -46,7 +46,7 @@ go get github.com/duke-git/lancet@v1.2.6 // 使用go1.18以下版本, 必须安
lancet是以包的结构组织代码的使用时需要导入相应的包名。例如如果使用字符串相关函数需要导入strutil包:
```go
import "github.com/duke-git/lancet/strutil"
import "github.com/duke-git/lancet/v2/strutil"
```
## 例子
@@ -73,7 +73,7 @@ func main() {
### algorithm算法包实现一些基本算法。eg. sort, search.
```go
import "github.com/duke-git/lancet/algorithm"
import "github.com/duke-git/lancet/v2/algorithm"
```
#### Function list:
- [BubbleSort](https://github.com/duke-git/lancet/blob/main/docs/algorithm_zh-CN.md#BubbleSort)
@@ -92,7 +92,7 @@ import "github.com/duke-git/lancet/algorithm"
### convertor转换器包支持一些常见的数据类型转换。
```go
import "github.com/duke-git/lancet/convertor"
import "github.com/duke-git/lancet/v2/convertor"
```
#### 函数列表:
- [ColorHexToRGB](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorHexToRGB)
@@ -108,7 +108,7 @@ import "github.com/duke-git/lancet/convertor"
### cryptor加密包支持数据加密和解密获取md5hash值。支持base64, md5, hmac, aes, des, rsa。
```go
import "github.com/duke-git/lancet/cryptor"
import "github.com/duke-git/lancet/v2/cryptor"
```
#### 函数列表:
@@ -149,7 +149,7 @@ import "github.com/duke-git/lancet/cryptor"
```go
import "github.com/duke-git/lancet/datetime"
import "github.com/duke-git/lancet/v2/datetime"
```
#### 函数列表:
- [AddDay](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#AddDay)
@@ -178,7 +178,7 @@ import "github.com/duke-git/lancet/datetime"
### fileutil包支持文件基本操作。
```go
import "github.com/duke-git/lancet/fileutil"
import "github.com/duke-git/lancet/v2/fileutil"
```
#### 函数列表:
@@ -201,7 +201,7 @@ import "github.com/duke-git/lancet/fileutil"
### formatter格式化器包含一些数据格式化处理方法。
```go
import "github.com/duke-git/lancet/formatter"
import "github.com/duke-git/lancet/v2/formatter"
```
#### 函数列表:
- [Comma](https://github.com/duke-git/lancet/blob/main/docs/formatter_zh-CN.md#Comma)
@@ -210,7 +210,7 @@ import "github.com/duke-git/lancet/formatter"
### function函数包控制函数执行流程包含部分函数式编程。
```go
import "github.com/duke-git/lancet/function"
import "github.com/duke-git/lancet/v2/function"
```
#### 函数列表:
@@ -225,7 +225,7 @@ import "github.com/duke-git/lancet/function"
### mathutil包实现了一些数学计算的函数。
```go
import "github.com/duke-git/lancet/mathutil"
import "github.com/duke-git/lancet/v2/mathutil"
```
#### Function list:
@@ -240,7 +240,7 @@ import "github.com/duke-git/lancet/mathutil"
### netutil网络包支持获取ip地址发送http请求。
```go
import "github.com/duke-git/lancet/netutil"
import "github.com/duke-git/lancet/v2/netutil"
```
#### 函数列表:
@@ -260,7 +260,7 @@ import "github.com/duke-git/lancet/netutil"
### random随机数生成器包可以生成随机[]bytes, int, string。
```go
import "github.com/duke-git/lancet/random"
import "github.com/duke-git/lancet/v2/random"
```
#### 函数列表:
@@ -271,7 +271,7 @@ import "github.com/duke-git/lancet/random"
### retry重试执行函数直到函数运行成功或被context cancel。
```go
import "github.com/duke-git/lancet/retry"
import "github.com/duke-git/lancet/v2/retry"
```
#### 函数列表:
@@ -285,7 +285,7 @@ import "github.com/duke-git/lancet/retry"
### slice包包含操作切片的方法集合。
```go
import "github.com/duke-git/lancet/slice"
import "github.com/duke-git/lancet/v2/slice"
```
#### 函数列表:
@@ -327,7 +327,7 @@ import "github.com/duke-git/lancet/slice"
### strutil包含处理字符串的相关函数。
```go
import "github.com/duke-git/lancet/strutil"
import "github.com/duke-git/lancet/v2/strutil"
```
#### 函数列表:
@@ -353,7 +353,7 @@ import "github.com/duke-git/lancet/strutil"
### system包含os, runtime, shell command相关函数。
```go
import "github.com/duke-git/lancet/system"
import "github.com/duke-git/lancet/v2/system"
```
#### 函数列表:
@@ -369,7 +369,7 @@ import "github.com/duke-git/lancet/system"
### validator验证器包包含常用字符串格式验证函数。
```go
import "github.com/duke-git/lancet/validator"
import "github.com/duke-git/lancet/v2/validator"
```
#### 函数列表:
@@ -404,7 +404,7 @@ validator.md#IsWeakPassword)
### xerror包实现一些错误处理函数
```go
import "github.com/duke-git/lancet/xerror"
import "github.com/duke-git/lancet/v2/xerror"
```
#### 函数列表:
- [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#Unwrap)