next-ws 1.1.0-next.2 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +8 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "next-ws",
3
- "version": "1.1.0-next.2",
3
+ "version": "1.1.0",
4
4
  "type": "module",
5
5
  "description": "Add support for WebSockets in Next.js 13 app directory",
6
6
  "license": "MIT",
package/readme.md CHANGED
@@ -13,8 +13,6 @@
13
13
  <a href="https://discord.gg/vZQbMhwsKY"><img src="https://discordapp.com/api/guilds/829836158007115806/widget.png?style=shield" alt="discord shield"/></a>
14
14
  </div>
15
15
 
16
-
17
-
18
16
  ## 🤔 About
19
17
 
20
18
  Next WS (`next-ws`) is an advanced Next.js plugin that seamlessly integrates WebSocket server capabilities directly into routes located in the **app directory**. With Next WS, you no longer require a separate server for WebSocket functionality.
@@ -24,9 +22,16 @@ Next WS (`next-ws`) is an advanced Next.js plugin that seamlessly integrates Web
24
22
 
25
23
  This module is inspired by the now outdated `next-plugin-websocket`, if you are using an older version of Next.js, that module may work for you.
26
24
 
27
-
28
25
  ## 🏓 Table of Contents
29
26
 
27
+ - [📦 Installation](#-installation)
28
+ - [🚀 Usage](#-usage)
29
+ - [🌀 Examples](#-examples)
30
+ - [Creating a Socket](#creating-a-socket)
31
+ - [Using a Custom Server](#using-a-custom-server)
32
+ - [Accessing the WebSocket Server](#accessing-the-websocket-server)
33
+ - [Client-Side Utilities](#client-side-utilities)
34
+
30
35
  ## 📦 Installation
31
36
 
32
37
  Setting up a WebSocket server with Next WS involves patching your local Next.js installation. Next WS simplifies this process with a CLI command that automatically detects and patches your Next.js version, ensuring compatibility. Note that Next.js version 13.1.1 or higher is required.