From dff9d30828914ba6a1c580996b147775ea5f02d4 Mon Sep 17 00:00:00 2001
From: Mathieu Carbou <mathieu.carbou@gmail.com>
Date: Tue, 4 Jun 2024 11:14:50 +0200
Subject: [PATCH] update doc

---
 README.md     | 15 +++++++++++++++
 docs/index.md | 15 +++++++++++++++
 2 files changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 7c226ac..8c56e7a 100644
--- a/README.md
+++ b/README.md
@@ -73,3 +73,18 @@ void send(JsonDocument& doc) {
 ```
 
 I recommend to use the official API `AsyncWebSocketMessageBuffer` to retain further compatibility.
+
+## Stack size and queues
+
+Here are some important flags to tweak depending on your needs:
+
+```cpp
+  // Async TCP queue size
+  -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128
+  // Async TCP async task core
+  -D CONFIG_ASYNC_TCP_RUNNING_CORE=1
+  // Async TCP async stac ksize
+  -D CONFIG_ASYNC_TCP_STACK_SIZE=8096
+  // WebSocket queue size
+  -D WS_MAX_QUEUED_MESSAGES=64
+```
diff --git a/docs/index.md b/docs/index.md
index 7c226ac..8c56e7a 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -73,3 +73,18 @@ void send(JsonDocument& doc) {
 ```
 
 I recommend to use the official API `AsyncWebSocketMessageBuffer` to retain further compatibility.
+
+## Stack size and queues
+
+Here are some important flags to tweak depending on your needs:
+
+```cpp
+  // Async TCP queue size
+  -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128
+  // Async TCP async task core
+  -D CONFIG_ASYNC_TCP_RUNNING_CORE=1
+  // Async TCP async stac ksize
+  -D CONFIG_ASYNC_TCP_STACK_SIZE=8096
+  // WebSocket queue size
+  -D WS_MAX_QUEUED_MESSAGES=64
+```