mirror of
https://github.com/duke-git/lancet.git
synced 2026-02-12 08:42:29 +08:00
update style of readme file
This commit is contained in:
18
README.md
18
README.md
@@ -1,9 +1,7 @@
|
|||||||
<div align="center">
|
<h1 style="width: 100%;">Lancet</h1>
|
||||||
<h1 style="width: 100%; text-align: center;">Lancet</h1>
|
<p style="font-size: 18px">
|
||||||
<p style="font-size: 18px">
|
Lancet is a comprehensive, efficient, and reusable util function library of go. Inspired by the java apache common package and lodash.js.
|
||||||
Lancet is a comprehensive, efficient, and reusable util function library of go. Inspired by the java apache common package and lodash.js.
|
</p>
|
||||||
</p>
|
|
||||||
<div align="center" style="text-align: center;">
|
|
||||||
|
|
||||||

|

|
||||||
[](https://github.com/duke-git/lancet/releases)
|
[](https://github.com/duke-git/lancet/releases)
|
||||||
@@ -13,13 +11,12 @@
|
|||||||
[](https://codecov.io/gh/duke-git/lancet)
|
[](https://codecov.io/gh/duke-git/lancet)
|
||||||
[](https://github.com/duke-git/lancet/blob/main/LICENSE)
|
[](https://github.com/duke-git/lancet/blob/main/LICENSE)
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
English | [简体中文](./README_zh-CN.md)
|
English | [简体中文](./README_zh-CN.md)
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### Feature
|
### Feature
|
||||||
|
---
|
||||||
|
|
||||||
- 👏 Comprehensive, efficient and reusable.
|
- 👏 Comprehensive, efficient and reusable.
|
||||||
- 💪 140+ common go util functions, support string, slice, datetime, net, crypt...
|
- 💪 140+ common go util functions, support string, slice, datetime, net, crypt...
|
||||||
@@ -27,12 +24,14 @@ English | [简体中文](./README_zh-CN.md)
|
|||||||
- 🌍 Unit test for every exported function.
|
- 🌍 Unit test for every exported function.
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
---
|
||||||
|
|
||||||
```go
|
```go
|
||||||
go get github.com/duke-git/lancet
|
go get github.com/duke-git/lancet
|
||||||
```
|
```
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
---
|
||||||
Lancet organizes the code into package structure, and you need to import the corresponding package name when use it. For example, if you use string-related functions,import the strutil package like below:
|
Lancet organizes the code into package structure, and you need to import the corresponding package name when use it. For example, if you use string-related functions,import the strutil package like below:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
@@ -40,6 +39,7 @@ import "github.com/duke-git/lancet/strutil"
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
---
|
||||||
|
|
||||||
Here takes the string function ReverseStr (reverse order string) as an example, and the strutil package needs to be imported.
|
Here takes the string function ReverseStr (reverse order string) as an example, and the strutil package needs to be imported.
|
||||||
|
|
||||||
@@ -59,7 +59,7 @@ func main() {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### API Documentation
|
### API Documentation
|
||||||
|
---
|
||||||
#### 1. convertor contains some functions for data convertion
|
#### 1. convertor contains some functions for data convertion
|
||||||
|
|
||||||
- Support conversion between commonly used data types.
|
- Support conversion between commonly used data types.
|
||||||
|
|||||||
@@ -1,9 +1,7 @@
|
|||||||
<div align="center">
|
<h1 style="width: 100%;">Lancet</h1>
|
||||||
<h1 style="width: 100%; text-align: center;">Lancet</h1>
|
<p style="font-size: 18px">
|
||||||
<p style="font-size: 18px">
|
lancet(柳叶刀)是一个全面、高效、可复用的go语言工具函数库。 lancet受到了java apache common包和lodash.js的启发。
|
||||||
lancet(柳叶刀)是一个全面、高效、可复用的go语言工具函数库。 lancet受到了java apache common包和lodash.js的启发。
|
</p>
|
||||||
</p>
|
|
||||||
<div align="center" style="text-align: center;">
|
|
||||||
|
|
||||||

|

|
||||||
[](https://github.com/duke-git/lancet/releases)
|
[](https://github.com/duke-git/lancet/releases)
|
||||||
@@ -13,27 +11,25 @@
|
|||||||
[](https://codecov.io/gh/duke-git/lancet)
|
[](https://codecov.io/gh/duke-git/lancet)
|
||||||
[](https://github.com/duke-git/lancet/blob/main/LICENSE)
|
[](https://github.com/duke-git/lancet/blob/main/LICENSE)
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
简体中文 | [English](./README.md)
|
简体中文 | [English](./README.md)
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
### 特性
|
### 特性
|
||||||
|
---
|
||||||
- 👏 全面、高效、可复用
|
- 👏 全面、高效、可复用
|
||||||
- 💪 140+常用go工具函数,支持string、slice、datetime、net、crypt...
|
- 💪 140+常用go工具函数,支持string、slice、datetime、net、crypt...
|
||||||
- 💅 只依赖go标准库
|
- 💅 只依赖go标准库
|
||||||
- 🌍 所有导出函数单元测试覆盖率100%
|
- 🌍 所有导出函数单元测试覆盖率100%
|
||||||
|
|
||||||
### 安装
|
### 安装
|
||||||
|
---
|
||||||
```go
|
```go
|
||||||
go get github.com/duke-git/lancet
|
go get github.com/duke-git/lancet
|
||||||
```
|
```
|
||||||
|
|
||||||
### 用法
|
### 用法
|
||||||
|
---
|
||||||
lancet是以包的结构组织代码的,使用时需要导入相应的包名。例如:如果使用字符串相关函数,需要导入strutil包:
|
lancet是以包的结构组织代码的,使用时需要导入相应的包名。例如:如果使用字符串相关函数,需要导入strutil包:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
@@ -41,7 +37,7 @@ import "github.com/duke-git/lancet/strutil"
|
|||||||
```
|
```
|
||||||
|
|
||||||
### 例子
|
### 例子
|
||||||
|
---
|
||||||
此处以字符串工具函数ReverseStr(逆序字符串)为例,需要导入strutil包:
|
此处以字符串工具函数ReverseStr(逆序字符串)为例,需要导入strutil包:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
@@ -60,7 +56,7 @@ func main() {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### API文档
|
### API文档
|
||||||
|
---
|
||||||
#### 1. convertor数据转换包
|
#### 1. convertor数据转换包
|
||||||
|
|
||||||
- 转换函数支持常用数据类型之间的转换
|
- 转换函数支持常用数据类型之间的转换
|
||||||
|
|||||||
Reference in New Issue
Block a user