go-pkg/asynq
2
0
Fork 0
mirror of https://github.com/hibiken/asynq.git synced 2024-12-26 07:42:17 +08:00
Code Issues Projects Releases Wiki Activity

[ci skip] Update readme

Browse Source
This commit is contained in:
Ken Hibino 2020-01-05 09:06:23 -08:00
parent 00b03e1287
commit 29ad70c36a
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,4 +1,6 @@
# Asynq [![Build Status](https://travis-ci.com/hibiken/asynq.svg?token=paqzfpSkF4p23s5Ux39b&branch=master)](https://travis-ci.com/hibiken/asynq) # Asynq
[![Build Status](https://travis-ci.com/hibiken/asynq.svg?token=paqzfpSkF4p23s5Ux39b&branch=master)](https://travis-ci.com/hibiken/asynq) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
Simple, efficent asynchronous task processing library in Go. Simple, efficent asynchronous task processing library in Go.
@ -8,6 +10,7 @@ Simple, efficent asynchronous task processing library in Go.
- [Requirements](#requirements) - [Requirements](#requirements)
- [Installation](#installation) - [Installation](#installation)
- [Getting Started](#getting-started) - [Getting Started](#getting-started)
- [Acknowledgements](#acknowledgements)
- [License](#license) - [License](#license)
## Overview ## Overview
@ -43,10 +46,13 @@ go get github.com/hibiken/asynq
## Getting Started ## Getting Started
1. Import `asynq` in your file. 1. Import `asynq` and `redis` in your file.
```go ```go
import "github.com/hibiken/asynq" import (
"github.com/go-redis/redis/v7"
"github.com/hibiken/asynq"
)
``` ```
2. Create a `Client` instance to create tasks. 2. Create a `Client` instance to create tasks.
@ -142,6 +148,11 @@ func main() {
} }
``` ```
## Acknowledgements
- [Sidekiq](https://github.com/mperham/sidekiq) : Many of the design ideas are taken from sidekiq and its Web UI
- [Cobra](https://github.com/spf13/cobra) : Asynqmon CLI is built with cobra
## License ## License
Asynq is released under the MIT license. See [LICENSE](https://github.com/hibiken/asynq/blob/master/LICENSE). Asynq is released under the MIT license. See [LICENSE](https://github.com/hibiken/asynq/blob/master/LICENSE).