diff --git a/README.md b/README.md index 27605a9..0a1f3c6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ -
-

Lancet

-

- Lancet is a comprehensive, efficient, and reusable util function library of go. Inspired by the java apache common package and lodash.js. -

-
+

Lancet

+

+ Lancet is a comprehensive, efficient, and reusable util function library of go. Inspired by the java apache common package and lodash.js. +

![Go version](https://img.shields.io/badge/go-%3E%3D1.16-9cf) [![Release](https://img.shields.io/badge/release-1.1.10-green.svg)](https://github.com/duke-git/lancet/releases) @@ -13,13 +11,12 @@ [![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) -
English | [简体中文](./README_zh-CN.md) -
### Feature +--- - 👏 Comprehensive, efficient and reusable. - 💪 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. ### Installation +--- ```go go get github.com/duke-git/lancet ``` ### 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: ```go @@ -40,6 +39,7 @@ import "github.com/duke-git/lancet/strutil" ``` ### Example +--- 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 - +--- #### 1. convertor contains some functions for data convertion - Support conversion between commonly used data types. diff --git a/README_zh-CN.md b/README_zh-CN.md index 60a3fb4..09b1a95 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -1,9 +1,7 @@ -
-

Lancet

-

- lancet(柳叶刀)是一个全面、高效、可复用的go语言工具函数库。 lancet受到了java apache common包和lodash.js的启发。 -

-
+

Lancet

+

+ lancet(柳叶刀)是一个全面、高效、可复用的go语言工具函数库。 lancet受到了java apache common包和lodash.js的启发。 +

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