playsocketjs 2.4.2 → 2.5.1

package/README.md

@@ -96,7 +96,7 @@ new PlaySocket(id?: string, options: PlaySocketOptions)
 ### Methods
 
 - `init()`: Initialize the WebSocket connection – Returns Promise (async) which resolves with the client's ID
-- `createRoom(initialStorage?: object, maxSize?: number)`: Create a new room and become host – Returns Promise (async) which resolves with the room ID (matches the creator's ID). The absolute client maximum is 100
+- `createRoom(initialStorage?: object, maxSize?: number)`: Create a new room and become host – Returns Promise (async) which resolves with the room ID. The room participant maximum is 100
 - `joinRoom(hostId: string)`: Join an existing room – Returns Promise (async)
 - `destroy()`: Use this to leave a room and close the connection
 - `updateStorage(key: string, type: 'set' | 'array-add' | 'array-add-unique' | 'array-remove-matching' | 'array-update-matching', value: any, updateValue?: any)`: Update the shared storage (max. 100 keys). Safely update arrays in storage by adding, removing, or updating items. UpdateValue is only required for the 'array-update-matching' operation type
@@ -141,7 +141,7 @@ Here are usage examples for a standalone server and an Express.js application.
 ### Standalone server
 
 ```javascript
-const PlaySocketServer = require('playsocketjs/server');
+import PlaySocketServer from 'playsocketjs/server'; // Both ES Module & CommonJS Module syntax is supported
 
 const server = new PlaySocketServer(); // Create and start the server (default path is /socket)
 
@@ -203,6 +203,7 @@ Creates a new PlaySocket Server instance with configuration options.
 - `port`: Port to listen on (default: 3000, used only if no server provided)
 - `path`: WebSocket endpoint path (default: '/')
 - `server`: Existing http server (optional)
+- `rateLimit`: Adjust the messages/second rate limit (defaults to 20)
 - `debug`: Set this property to true to enable extra logging
 
 ### Methods