Skip to content

Commit e185c51

Browse files
committed
doc: update readme
Signed-off-by: Chen Su <ghosind@gmail.com>
1 parent c6017d9 commit e185c51

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README-CN.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ go get -u github.com/ghosind/go-async
2525
import "github.com/ghosind/go-async"
2626
```
2727

28+
> [!NOTE]
29+
> 本工具集尚未稳定,后续版本可能会有不兼容的更改。
30+
2831
## 入门
2932

3033
下面的代码中,通过`All`函数并发执行函数直到全部执行完成,并返回它们的返回结果。
@@ -54,6 +57,7 @@ out, err := async.All(func (ctx context.Context) (int, error) {
5457

5558
- [`All`](https://pkg.go.dev/github.com/ghosind/go-async#All)
5659
- [`AllCompleted`](https://pkg.go.dev/github.com/ghosind/go-async#AllCompleted)
60+
- [`Fallback`](https://pkg.go.dev/github.com/ghosind/go-async#Fallback)
5761
- [`Forever`](https://pkg.go.dev/github.com/ghosind/go-async#Forever)
5862
- [`Parallel`](https://pkg.go.dev/github.com/ghosind/go-async#Parallel)
5963
- [`ParallelCompleted`](https://pkg.go.dev/github.com/ghosind/go-async#ParallelCompleted)

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ And then, import the library into your own code.
2525
import "github.com/ghosind/go-async"
2626
```
2727

28+
> [!NOTE]
2829
> This library is not stable yet, anything may change in the later versions.
2930
3031
## Getting Started
@@ -56,6 +57,7 @@ For all functions, you can use the `XXXWithContext` function (like `AllWithConte
5657

5758
- [`All`](https://pkg.go.dev/github.com/ghosind/go-async#All)
5859
- [`AllCompleted`](https://pkg.go.dev/github.com/ghosind/go-async#AllCompleted)
60+
- [`Fallback`](https://pkg.go.dev/github.com/ghosind/go-async#Fallback)
5961
- [`Forever`](https://pkg.go.dev/github.com/ghosind/go-async#Forever)
6062
- [`Parallel`](https://pkg.go.dev/github.com/ghosind/go-async#Parallel)
6163
- [`ParallelCompleted`](https://pkg.go.dev/github.com/ghosind/go-async#ParallelCompleted)

0 commit comments

Comments
 (0)