Skip to content

docs: improve README #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# GTA - Go Task Async

A lightweight and reliable asynchronous task and transaction message library for Golang.  [🇺🇸English | [🇨🇳中文](README_zh-CN.md)]
Expand Down Expand Up @@ -106,7 +108,7 @@ All optional configurations and default values are as follows:
|RunningTimeout | time.Duration | 30 minutes | determines how long an ongoing task will be considered abnormal|
|WaitTimeout | time.Duration | waiting all the time | determines the longest execution time of the `Stop` function when a task is running |
|ScanInterval | time.Duration | 5 seconds | determines the speed of scanning initialized task under normal circumstances|
|InstantScanInvertal | time. Duration | 100 ms | determines the scan speed when there are unprocessed initialized tasks|
|InstantScanInterval | time. Duration | 100 ms | determines the scan speed when there are unprocessed initialized tasks|
|CtxMarshaler | CtxMarshaler | defaultCtxMarshaler | determines how context is serialized|
|CheckCallback | func(logger Logger, abnormalTasks []Task) | defaultcheckcallback | determines how to handle the detected abnormal task|
|DryRun | bool | false | dry run flag is used to test and determines whether to run without relying on the database|
Expand Down Expand Up @@ -156,4 +158,4 @@ You can use `WithDryRun(true)` to make the framework enter dry running mode to a

## License

[MIT](https://github.com/ycydsxy/gta/blob/main/LICENSE)
[MIT](https://github.com/ycydsxy/gta/blob/main/LICENSE)