Add note about custom server to readme

apteryxxyz · Oct 28, 2024 · b643b1f · b643b1f
1 parent 80d9429
commit b643b1f
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/packages/cli/readme.md b/packages/cli/readme.md
@@ -102,6 +102,9 @@ export function SOCKET(
 
 ### Using a Custom Server
 
+> [!IMPORTANT]  
+> Next WS was made to avoid the need for a custom server, if you are using one, you don't need this package and can just use a websocket server directly.
+
 To use a custom server, all you need to do is tell Next WS to use your server instead of creating its own. This can be done by calling the `setHttpServer` and `setWebSocketServer` functions from `next-ws/server` and passing your server instances.
 
 ```ts

diff --git a/packages/core/readme.md b/packages/core/readme.md
@@ -102,6 +102,9 @@ export function SOCKET(
 
 ### Using a Custom Server
 
+> [!IMPORTANT]  
+> Next WS was made to avoid the need for a custom server, if you are using one, you don't need this package and can just use a websocket server directly.
+
 To use a custom server, all you need to do is tell Next WS to use your server instead of creating its own. This can be done by calling the `setHttpServer` and `setWebSocketServer` functions from `next-ws/server` and passing your server instances.
 
 ```ts

diff --git a/readme.md b/readme.md
@@ -102,6 +102,9 @@ export function SOCKET(
 
 ### Using a Custom Server
 
+> [!IMPORTANT]  
+> Next WS was made to avoid the need for a custom server, if you are using one, you don't need this package and can just use a websocket server directly.
+
 To use a custom server, all you need to do is tell Next WS to use your server instead of creating its own. This can be done by calling the `setHttpServer` and `setWebSocketServer` functions from `next-ws/server` and passing your server instances.
 
 ```ts