Skip to content
This repository was archived by the owner on Jun 12, 2026. It is now read-only.

Commit 0abdb96

Browse files
lvan100lianghuan
lvan100
authored and
lianghuan
committed
improve documentation
1 parent 2df919a commit 0abdb96

6 files changed

Lines changed: 532 additions & 50 deletions

File tree

‎README.md‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,51 @@
11
# stdlib
22

3+
<div>
4+
<img src="https://img.shields.io/github/license/go-spring/stdlib" alt="license"/>
5+
<img src="https://img.shields.io/github/go-mod/go-version/go-spring/stdlib" alt="go-version"/>
6+
<img src="https://img.shields.io/github/v/release/go-spring/stdlib?include_prereleases" alt="release"/>
7+
<a href="https://codecov.io/gh/go-spring/stdlib" >
8+
<img src="https://codecov.io/gh/go-spring/stdlib/branch/main/graph/badge.svg?token=SX7CV1T0O8" alt="test-coverage"/>
9+
</a>
10+
<a href="https://goreportcard.com/report/github.com/go-spring/stdlib">
11+
<img src="https://goreportcard.com/badge/github.com/go-spring/stdlib" alt="Go Report Card"/>
12+
</a>
13+
<a href="https://deepwiki.com/go-spring/stdlib"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
14+
</div>
15+
316
[English](README.md) | [中文](README_CN.md)
417

5-
`stdlib` is a collection of independent utility modules written in Go.
18+
`stdlib` is a collection of high-quality independent utility modules written in Go.
19+
It provides carefully crafted tools that complement the Go standard library,
20+
making everyday Go development more convenient and enjoyable.
21+
22+
Each module is independent and can be used separately. Detailed documentation is available in each module's directory.
23+
24+
## Available Modules
25+
26+
| Module | Description |
27+
|--------|-------------|
28+
| [ctxcache](./ctxcache/) | Context-based caching utilities |
29+
| [errutil](./errutil/) | Error handling utilities, provides error wrapping, stack trace capture and more |
30+
| [fileutil](./fileutil/) | File system utilities |
31+
| [flatten](./flatten/) | Flatten nested data structures |
32+
| [formutil](./formutil/) | Form processing utilities |
33+
| [funcutil](./funcutil/) | Function utilities, lazy evaluation, partial application and more |
34+
| [goutil](./goutil/) | Generic Go language utilities, context cancellation control and more |
35+
| [hashutil](./hashutil/) | Hashing utilities |
36+
| [httpclt](./httpclt/) | HTTP client utilities |
37+
| [httpsvr](./httpsvr/) | HTTP server utilities |
38+
| [iterutil](./iterutil/) | Iterator and loop processing utilities |
39+
| [jsonflow](./jsonflow/) | JSON streaming processing toolkit |
40+
| [listutil](./listutil/) | List and linked list utilities |
41+
| [mathutil](./mathutil/) | Math and numeric utilities |
42+
| [md5util](./md5util/) | MD5 hashing convenience utilities |
43+
| [netutil](./netutil/) | Network related utilities |
44+
| [ordered](./ordered/) | Ordered map and set data structures |
45+
| [patchutil](./patchutil/) | Patch processing utilities |
46+
| [testing](./testing/) | Elegant fluent-style assertion library for unit testing, supports `assert` and `require` modes with type-specific assertions |
47+
| [textstyle](./textstyle/) | Text style and formatting utilities |
48+
| [typeutil](./typeutil/) | Type reflection and conversion utilities |
649

750
## License
851

‎README_CN.md‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,49 @@
11
# stdlib
22

3+
<div>
4+
<img src="https://img.shields.io/github/license/go-spring/stdlib" alt="license"/>
5+
<img src="https://img.shields.io/github/go-mod/go-version/go-spring/stdlib" alt="go-version"/>
6+
<img src="https://img.shields.io/github/v/release/go-spring/stdlib?include_prereleases" alt="release"/>
7+
<a href="https://codecov.io/gh/go-spring/stdlib" >
8+
<img src="https://codecov.io/gh/go-spring/stdlib/branch/main/graph/badge.svg?token=SX7CV1T0O8" alt="test-coverage"/>
9+
</a>
10+
<a href="https://goreportcard.com/report/github.com/go-spring/stdlib">
11+
<img src="https://goreportcard.com/badge/github.com/go-spring/stdlib" alt="Go Report Card"/>
12+
</a>
13+
<a href="https://deepwiki.com/go-spring/stdlib"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
14+
</div>
15+
316
[English](README.md) | [中文](README_CN.md)
417

5-
`stdlib` 是一个包含多个独立 Go 语言工具模块的集合库。
18+
`stdlib` 是一系列精心设计的独立 Go 语言工具模块集合，对 Go 标准库进行了有益补充，让日常 Go 开发更加便捷愉悦。
19+
20+
每个模块都是独立的，可以单独使用。每个模块目录下都有详细的文档说明。
21+
22+
## 可用模块
23+
24+
| 模块 | 说明 |
25+
|--------|-------------|
26+
| [ctxcache](./ctxcache/) | 基于 Context 的缓存工具 |
27+
| [errutil](./errutil/) | 错误处理工具，提供错误包装、栈追踪捕获等功能 |
28+
| [fileutil](./fileutil/) | 文件系统工具 |
29+
| [flatten](./flatten/) | 嵌套数据结构扁平化 |
30+
| [formutil](./formutil/) | 表单处理工具 |
31+
| [funcutil](./funcutil/) | 函数工具，延迟求值、偏函数应用等 |
32+
| [goutil](./goutil/) | Go 通用工具，上下文取消控制等功能 |
33+
| [hashutil](./hashutil/) | 哈希计算工具 |
34+
| [httpclt](./httpclt/) | HTTP 客户端工具 |
35+
| [httpsvr](./httpsvr/) | HTTP 服务端工具 |
36+
| [iterutil](./iterutil/) | 迭代器和循环处理工具 |
37+
| [jsonflow](./jsonflow/) | JSON 流式处理工具包 |
38+
| [listutil](./listutil/) | 列表和链表工具 |
39+
| [mathutil](./mathutil/) | 数学数值工具 |
40+
| [md5util](./md5util/) | MD5 哈希便捷工具 |
41+
| [netutil](./netutil/) | 网络相关工具 |
42+
| [ordered](./ordered/) | 有序 Map 和有序 Set 数据结构 |
43+
| [patchutil](./patchutil/) | 补丁处理工具 |
44+
| [testing](./testing/) | 优雅的流式 API 风格单元测试断言库，支持 `assert` 和 `require` 两种模式，提供丰富的类型专属断言 |
45+
| [textstyle](./textstyle/) | 文本样式格式化工具 |
46+
| [typeutil](./typeutil/) | 类型反射和转换工具 |
647

748
## 许可证
849

‎ctxcache/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Use the `Set` function to assign a value to a key:
3838
```go
3939
err := ctxcache.Set(ctx, "user", userInfo)
4040
if err != nil {
41-
// handle error
41+
// handle error
4242
}
4343
```
4444

@@ -51,7 +51,7 @@ Use the `Get` function to retrieve a value:
5151
```go
5252
value, err := ctxcache.Get[UserType](ctx, "user")
5353
if err != nil {
54-
// handle error
54+
// handle error
5555
}
5656
```
5757

‎ctxcache/README_CN.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ defer cancel() // 在请求边界处清理缓存
3636
```go
3737
err := ctxcache.Set(ctx, "user", userInfo)
3838
if err != nil {
39-
// 处理错误
39+
// 处理错误
4040
}
4141
```
4242

@@ -49,7 +49,7 @@ if err != nil {
4949
```go
5050
value, err := ctxcache.Get[UserType](ctx, "user")
5151
if err != nil {
52-
// 处理错误
52+
// 处理错误
5353
}
5454
```
5555

0 commit comments

Comments
 (0)