Skip to content

Commit

Permalink
docs(queue): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Planxnx committed Oct 23, 2023
1 parent a8583ff commit 89774b3
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,8 @@ Pure Golang errors library with stacktrace support (for wrapping and formatting

## queue

A Pure Golang thread-safe and unlimited-size generics in-memory message queue implementation
that supports async enqueue and blocking dequeue. \
It's alternative way to communicate between goroutines compared to `channel`
A Pure Golang low-level and simple queue library for thread-safe and unlimited-size generics in-memory message queue implementation (async enqueue and blocking dequeue supports).\
The alternative way to communicate between goroutines compared to `channel`

[See here](queue/README.md).

Expand Down
5 changes: 5 additions & 0 deletions queue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ It's alternative way to communicate between goroutines compared to `channel`
>
> And if your use-case requires a limited-size queue and blocking enqueue, please use a channel instead.
This package is low-level and simple queue library, it's not a full-featured message queue. \
You can build any advanced message queue on top of this queue (use this queue for under the hood)
like an advance message queue like a single-producer with multiple-consumers queue,
broadcast system, multiple topics queue or any other use-cases.

## Installation

```shell
Expand Down
1 change: 1 addition & 0 deletions queue/queue.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
// It's alternative way to communicate between goroutines compared to `channel`.
// The implementation of this in-memory message queue uses sync.Cond instead of channel.
//
// This queue is low-level and simple library, it's not a full-featured message queue.
// If your use-case requires a limited-size queue and blocking enqueue, please use a channel instead.
// For advanced use-cases like distributed queue, persistent message please use a message broker like Kafka, RabbitMQ, NATES or NSQ instead.
//
Expand Down

0 comments on commit 89774b3

Please sign in to comment.