From 29ad70c36a3dc4aef0db028bb9a8292fab7481eb Mon Sep 17 00:00:00 2001 From: Ken Hibino Date: Sun, 5 Jan 2020 09:06:23 -0800 Subject: [PATCH] [ci skip] Update readme --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 40a3c72..a957c78 100644 --- a/README.md +++ b/README.md @@ -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. @@ -8,6 +10,7 @@ Simple, efficent asynchronous task processing library in Go. - [Requirements](#requirements) - [Installation](#installation) - [Getting Started](#getting-started) +- [Acknowledgements](#acknowledgements) - [License](#license) ## Overview @@ -43,10 +46,13 @@ go get github.com/hibiken/asynq ## Getting Started -1. Import `asynq` in your file. +1. Import `asynq` and `redis` in your file. ```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. @@ -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 Asynq is released under the MIT license. See [LICENSE](https://github.com/hibiken/asynq/blob/master/LICENSE).