docs: update example (#13)

Signed-off-by: Bo-Yi Wu <[email protected]>

Author: appleboy

README.md

@@ -13,13 +13,21 @@ Queue is a Golang library for spawning and managing a Goroutine pool, Alloowing
 
 ## Installation
 
+Install the stable version:
+
 ```sh
 go get github.com/appleboy/queue
 ```
 
+Install the latest verison:
+
+```sh
+go get github.com/appleboy/queue@master
+```
+
 ## Usage
 
-First to create new job as `QueueMessage` interface:
+The first step to create a new job as `QueueMessage` interface:
 
 ```go
 type job struct {
@@ -31,13 +39,13 @@ func (j *job) Bytes() []byte {
 }
 ```
 
-Second to create the new worker, use buffered channel as example:
+The second step to create the new worker, use the buffered channel as an example, you can use the `stop` channel to terminate the job immediately after shutdown the queue service if need.
 
 ```go
 	// define the worker
 	w := simple.NewWorker(
 		simple.WithQueueNum(taskN),
-		simple.WithRunFunc(func(m queue.QueuedMessage) error {
+		simple.WithRunFunc(func(m queue.QueuedMessage, stop <-chan struct{}) error {
 			v, ok := m.(*job)
 			if !ok {
 				if err := json.Unmarshal(m.Bytes(), &v); err != nil {
@@ -51,7 +59,7 @@ Second to create the new worker, use buffered channel as example:
 	)
 ```
 
-or you can use the [NSQ](https://nsq.io/) as backend, see the worker example:
+or use the [NSQ](https://nsq.io/) as backend, see the worker example:
 
 ```go
 	// define the worker
@@ -61,7 +69,7 @@ or you can use the [NSQ](https://nsq.io/) as backend, see the worker example:
 		nsq.WithChannel("foobar"),
 		// concurrent job number
 		nsq.WithMaxInFlight(10),
-		nsq.WithRunFunc(func(m queue.QueuedMessage) error {
+		nsq.WithRunFunc(func(m queue.QueuedMessage, stop <-chan struct{}) error {
 			v, ok := m.(*job)
 			if !ok {
 				if err := json.Unmarshal(m.Bytes(), &v); err != nil {
@@ -75,7 +83,7 @@ or you can use the [NSQ](https://nsq.io/) as backend, see the worker example:
 	)
 ```
 
-Third to create queue and initialize multiple worker, receive all job message:
+The third step to create a queue and initialize multiple workers, receive all job messages:
 
 ```go
 	// define the queue
@@ -109,7 +117,7 @@ Third to create queue and initialize multiple worker, receive all job message:
 	q.Wait()
 ```
 
-Full example code as below or [try it in playground](https://play.golang.org/p/ZM3XAnYcAs7).
+Full example code as below or [try it in playground](https://play.golang.org/p/yaTUoYxdcaK).
 
 ```go
 package main
@@ -139,7 +147,7 @@ func main() {
 	// define the worker
 	w := simple.NewWorker(
 		simple.WithQueueNum(taskN),
-		simple.WithRunFunc(func(m queue.QueuedMessage) error {
+		simple.WithRunFunc(func(m queue.QueuedMessage, _ <-chan struct{}) error {
 			v, ok := m.(*job)
 			if !ok {
 				if err := json.Unmarshal(m.Bytes(), &v); err != nil {

_example/nsq/go.mod

@@ -2,4 +2,4 @@ module example
 
 go 1.16
 
-require github.com/appleboy/queue v0.0.4-0.20210725052905-4ef008157945
+require github.com/appleboy/queue v0.0.4-0.20210726005953-79774a856a1e

_example/nsq/go.sum

@@ -2,6 +2,8 @@ github.com/appleboy/queue v0.0.3 h1:rntqVTm6ilh80VCVQjwA0vDMCl1cfveq6GS6X98fKwE=
 github.com/appleboy/queue v0.0.3/go.mod h1:6Mn0z4hURZW/26huvRXG0SJ4o7pBdo6hOryRiegy/4Q=
 github.com/appleboy/queue v0.0.4-0.20210725052905-4ef008157945 h1:Mec41QJ0hGDtbyfWgHfuXKqTu0a8hSIIBhL3sNbNjqQ=
 github.com/appleboy/queue v0.0.4-0.20210725052905-4ef008157945/go.mod h1:6Mn0z4hURZW/26huvRXG0SJ4o7pBdo6hOryRiegy/4Q=
+github.com/appleboy/queue v0.0.4-0.20210726005953-79774a856a1e h1:+Mj8GY3F5J6rJCUoUlqAu68UUwaP2B3G4Xce5eSBNY0=
+github.com/appleboy/queue v0.0.4-0.20210726005953-79774a856a1e/go.mod h1:6Mn0z4hURZW/26huvRXG0SJ4o7pBdo6hOryRiegy/4Q=
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/golang/snappy v0.0.1 h1:Qgr9rKW7uDUkrbSmQeiDsGa8SjGyCOGtuasMWwvp2P4=

_example/nsq/main.go

@@ -33,7 +33,7 @@ func main() {
 		nsq.WithChannel("foobar"),
 		// concurrent job number
 		nsq.WithMaxInFlight(10),
-		nsq.WithRunFunc(func(m queue.QueuedMessage) error {
+		nsq.WithRunFunc(func(m queue.QueuedMessage, _ <-chan struct{}) error {
 			v, ok := m.(*job)
 			if !ok {
 				if err := json.Unmarshal(m.Bytes(), &v); err != nil {

_example/simple/go.mod

@@ -2,4 +2,4 @@ module example
 
 go 1.16
 
-require github.com/appleboy/queue v0.0.4-0.20210725052905-4ef008157945 // indirect
+require github.com/appleboy/queue v0.0.4-0.20210726005953-79774a856a1e // indirect

_example/simple/go.sum

@@ -2,6 +2,8 @@ github.com/appleboy/queue v0.0.3 h1:rntqVTm6ilh80VCVQjwA0vDMCl1cfveq6GS6X98fKwE=
 github.com/appleboy/queue v0.0.3/go.mod h1:6Mn0z4hURZW/26huvRXG0SJ4o7pBdo6hOryRiegy/4Q=
 github.com/appleboy/queue v0.0.4-0.20210725052905-4ef008157945 h1:Mec41QJ0hGDtbyfWgHfuXKqTu0a8hSIIBhL3sNbNjqQ=
 github.com/appleboy/queue v0.0.4-0.20210725052905-4ef008157945/go.mod h1:6Mn0z4hURZW/26huvRXG0SJ4o7pBdo6hOryRiegy/4Q=
+github.com/appleboy/queue v0.0.4-0.20210726005953-79774a856a1e h1:+Mj8GY3F5J6rJCUoUlqAu68UUwaP2B3G4Xce5eSBNY0=
+github.com/appleboy/queue v0.0.4-0.20210726005953-79774a856a1e/go.mod h1:6Mn0z4hURZW/26huvRXG0SJ4o7pBdo6hOryRiegy/4Q=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
 github.com/nsqio/go-nsq v1.0.8/go.mod h1:vKq36oyeVXgsS5Q8YEO7WghqidAVXQlcFxzQbQTuDEY=

_example/simple/main.go

@@ -25,7 +25,7 @@ func main() {
 	// define the worker
 	w := simple.NewWorker(
 		simple.WithQueueNum(taskN),
-		simple.WithRunFunc(func(m queue.QueuedMessage) error {
+		simple.WithRunFunc(func(m queue.QueuedMessage, _ <-chan struct{}) error {
 			v, ok := m.(*job)
 			if !ok {
 				if err := json.Unmarshal(m.Bytes(), &v); err != nil {