Skip to content

Commit c2e5b95

Browse files
committed
Improve README formatting and update Redis image
Use standard Markdown syntax for images and code blocks to improve readability Switch to latest Redis image for up-to-date features
1 parent 34ec645 commit c2e5b95

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# JoobQ
22

3-
<img src="./joobq-logo.png" alt="JoobQ Logo">
3+
![JoobQ Logo](./joobq-logo.png)
44

55
[![Crystal CI](https://github.com/azutoolkit/joobq/actions/workflows/crystal.yml/badge.svg)](https://github.com/azutoolkit/joobq/actions/workflows/crystal.yml)
66

@@ -111,7 +111,7 @@ REDIS_TIMEOUT=0.2
111111

112112
Queues are of type Hash(String, Queue(T)) where the name of the key matches the name of the Queue.
113113

114-
**Example**
114+
**Example:**
115115

116116
```crystal
117117
JoobQ.configure do
@@ -126,7 +126,7 @@ JoobQ.configure do
126126
end
127127
```
128128

129-
**Jobs**
129+
**Jobs:**
130130

131131
To define Jobs, include the JoobQ::Job module, and implement the perform method.
132132

@@ -201,7 +201,7 @@ This endpoint returns all available registered jobs and their JSON schemas that
201201

202202
**Request:**
203203

204-
```httpie
204+
```http
205205
GET /jobs/registry HTTP/1.1
206206
Host: localhost:8080
207207
```
@@ -228,7 +228,7 @@ This endpoint allows users to enqueue jobs.
228228

229229
**Request:**
230230

231-
```httpie
231+
```http
232232
POST /enqueue HTTP/1.1
233233
Host: localhost:8080
234234
Content-Type: application/json

docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
version: '3.7'
22
services:
33
redis:
4-
image: redislabs/redistimeseries:1.4.3
4+
image: redis/latest
55
ports:
66
- "6379:6379"

0 commit comments

Comments
 (0)