docs: clean up outdated examples

weyoss · Dec 2, 2023 · dd1c68b · dd1c68b
1 parent bc57d7b
commit dd1c68b
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 25 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -2,20 +2,23 @@
 
 # RedisSMQ Docs
 
-- [API Reference](api/README.md)
+## API Reference
+
+See [API Reference](api/README.md) for more details.
+
+## Getting Started
+
 - [Configuration](configuration.md)
-- Getting started
-    - [Queues](queues.md)
-    - [Producing Messages](producing-messages.md)
-    - [Consuming Messages](consuming-messages.md)
-    - [Messages](messages.md)
+- [Queues](queues.md)
+- [Producing Messages](producing-messages.md)
+- [Consuming Messages](consuming-messages.md)
+- [Messages](messages.md)
 - [Message Exchanges](message-exchanges.md)
 - [Queue Rate Limiting](queue-rate-limiting.md)
 - [Multiplexing](multiplexing.md)
 - [Scheduling Messages](scheduling-messages.md)
 - [Performance](performance.md)
 - [RedisSMQ Architecture](redis-smq-architecture.md)
 - [Logs](https://github.com/weyoss/redis-smq-common/blob/master/docs/README.md#logs)
-- Extra
-  - [HTTP API](https://github.com/weyoss/redis-smq-monitor)
-  - [Web UI](https://github.com/weyoss/redis-smq-monitor-client)
+- [HTTP API](https://github.com/weyoss/redis-smq-monitor)
+- [Web UI](https://github.com/weyoss/redis-smq-monitor-client)
diff --git a/docs/installation.md b/docs/installation.md
diff --git a/docs/queue-rate-limiting.md b/docs/queue-rate-limiting.md
@@ -22,7 +22,7 @@ To configure and view rate limiting parameters for a queue, the [QueueRateLimit]
 ```javascript
 const { QueueRateLimit } = require('redis-smq');
 
-const queueRateLimit = new QueueRateLimit(config);
+const queueRateLimit = new QueueRateLimit();
 // Setting a rate limit of 200 msg/min for the 'notofications' queue
 queueRateLimit.set('notifications', { limit: 200, interval: 60000 }, (err) => {
   // ...

diff --git a/docs/queues.md b/docs/queues.md
@@ -17,7 +17,7 @@ In a LIFO queue the last published messages are always delivered first and the f
 ```javascript
 const { Queue } = require('redis-smq');
 
-const queue = new Queue(config);
+const queue = new Queue();
 
 // Creating a LIFO queue named 'my_lifo_queue' in the 'default' namespace.
 queue.save('my_lifo_queue', EQueueType.LIFO_QUEUE, (err) => console.log(err));
@@ -32,7 +32,7 @@ In a FIFO queue the first published messages are delivered first and the last pu
 ```javascript
 const { QueueManager } = require('redis-smq');
 
-const queue = new Queue(config);
+const queue = new Queue();
 
 // Creating a FIFO queue named 'my_fifo_queue' in the 'default' namespace.
 queue.save('my_fifo_queue', EQueueType.FIFO_QUEUE, (err) => console.log(err));
@@ -47,7 +47,7 @@ In a priority queue, messages with higher priority are always delivered first be
 ```javascript
 const { QueueManager } = require('redis-smq');
 
-const queue = new Queue(config);
+const queue = new Queue();
 
 // Creating a PRIORITY queue named 'my_priority_queue' in the 'default' namespace.
 queue.save('my_priority_queue', EQueueType.PRIORITY_QUEUE, (err) => console.log(err));