From 24d19c2d9fd1c259f69ed2705eb7839763eb712f Mon Sep 17 00:00:00 2001
From: Dor Shtaif <dorshtaif@gmail.com>
Date: Mon, 10 Feb 2025 14:41:49 +0200
Subject: [PATCH] add TOC for `README.md`

---
 README.md | 46 +++++++++++++++++++++++++++++++++-------------
 1 file changed, 33 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 57d1a69..0317b3a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 # Qyu
+
 `qyu` is a general-purpose asynchronous job queue for the browser and Node.js. It is flexible and easy to use, always accepting jobs and running them as fast as the concurrency settings dictate.
 
 Qyu was meant for:
@@ -46,19 +47,38 @@ await q.whenEmpty(); // When all tasks finished and queue is empty...
 
 # Features
 
-- Always on and ready to receive additional tasks
-- Configurable concurrency limit
-- Configurable queue capacity limit
-- Configurable priority per individual tasks
-- Configurable queue timeout duration per individual tasks
-- Pause/resume queue execution
-- Compatible for browsers as well as Node.js environments
-- Written in TypeScript, full type definitions built-in
-- Provides both CJS and ESM builds
+  - ✔️ Always on and ready to receive additional tasks
+  - ✔️ Configurable concurrency limit
+  - ✔️ Configurable queue capacity limit
+  - ✔️ Configurable priority per individual tasks
+  - ✔️ Configurable queue timeout duration per individual tasks
+  - ✔️ Pause/resume queue execution
+  - ✔️ Compatible for browsers as well as Node.js environments
+  - ✔️ Written in TypeScript, full type definitions built-in
+  - ✔️ Provides both CJS and ESM builds
+
+
+
+# Table of Contents
+
+  - [Instance Config](#instance-config)
+    - [`concurrency`](#concurrency)
+    - [`capacity`](#capacity)
+    - [`rampUpTime`](#rampuptime)
+  - [Queuing options](#queuing-option)
+    - [`priority`](#priority)
+    - [`timeout`](#timeout)
+  - [API](#api)
+    - [instance(`jobs`)](#instancejobs)
+    - [instance#whenEmpty()](#instancewhenempty)
+    - [instance#whenFree()](#instancewhenfree)
+    - [instance#pause()](#instancepause)
+    - [instance#resume()](#instanceresume)
+    - [instance#empty()](#instanceempty)
+    - [instance#set(`config`)](#instancesetconfig)
+  - [Examples](#examples)
+
 
-<!--
-    TODO: Add "Table of Contents" here like in `iterified`!
--->
 
 # Instance Config
 
@@ -99,7 +119,7 @@ for (let i = 0; i < 6; i++) {
 }
 ```
 
-#### rampUpTime:
+#### `rampUpTime`:
 
 If specified a non-zero number, will delay the concurrency-ramping-up time of additional job executions, one by one, as the instance attempts to reach maximum configured concurrency.
 Represents number of milliseconds.