Skip to content

Commit

Permalink
docs: add workflow diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
J0sueTM committed Jul 3, 2024
1 parent e049c8c commit fbbae8d
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,37 @@ RQ (Redis Queue) is a simple Clojure package for queueing jobs and processing th
(rq/close-client *redis-pool*)
```

The workflow in the given example can be represented as follows:

```mermaid
sequenceDiagram
participant User
participant Client
participant Queue
participant PubSub
participant Logger
User->>Client: create-client URL
Client-->>Logger: log client creation
Client-->>User: return client
User->>Queue: push! message
Queue-->>Logger: log push message
Queue-->>Queue: push message to queue
User->>PubSub: publish! channel, message
PubSub-->>Logger: log publish message
PubSub-->>PubSub: publish message to channel
User->>Queue: pop! queue-name
Queue-->>Logger: log pop operation
Queue-->>User: return popped message
User->>Client: close-client client
Client-->>Logger: log closing client
Client-->>User: confirm client closure
```

## installation

We distribute the library via [Clojars](https://clojars.org/com.moclojer/rq).
Expand Down

0 comments on commit fbbae8d

Please sign in to comment.