Skip to content

Commit 0fb93db

Browse files
committed
Improved README.md
1 parent 9a528df commit 0fb93db

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This is our first open-source release. Please add a ⭐ if you like the idea of
44

55
Consider joining our community aswell! https://discord.gg/8ed3W53kHv/ to see progress on our very advanced projects and enjoy early-access benefits while you still can!
66

7+
DevForum Post: https://devforum.roblox.com/t/3503750
8+
79
## Overview
810
RBXConnectionManager is a lightweight and efficient module for managing `RBXScriptConnection` objects in Roblox. It allows for easy connection handling, automatic cleanup, and optional event monitoring.
911

@@ -17,7 +19,7 @@ RBXConnectionManager is a lightweight and efficient module for managing `RBXScri
1719
---
1820

1921
## Installation
20-
1. Add `RBXConnectionManager.lua` to your Roblox project.
22+
1. Add `RBXConnectionManager.luau` to your Roblox project.
2123
2. Require the module where needed:
2224
```lua
2325
local RBXConnectionManager = require(path.to.rbxconnectionmanager)
@@ -62,17 +64,18 @@ connectionManager:GetAllMonitoringData()
6264
```
6365

6466
### Destroying the Manager
67+
This will also disconnect all existing connections (like connectionManager:DisconnectAll() does)
6568
```lua
6669
connectionManager:Destroy()
6770
```
6871

6972
---
7073

71-
### Basic Example (Car Show)
74+
### Basic Example (Server-side Car Show Handler)
7275

7376
```lua
7477
local Players = game:GetService("Players")
75-
local RBXConnectionManager = require(game.ServerScriptService.RBXConnectionManager)
78+
local RBXConnectionManager = require(game.ServerScriptService.rbxconnectionmanager)
7679

7780
-- Create a new connection manager
7881
local connectionManager = RBXConnectionManager.new()
@@ -85,6 +88,7 @@ Players.PlayerAdded:Connect(function(playerObj)
8588
local userid = playerObj.UserId
8689
connectionManager:Connect("OnCarShowClicked_" .. tostring(userid), remoteEvent.OnServerEvent, function(triggeringPlayer, data)
8790
print(triggeringPlayer.Name .. " triggered the event with data:", data)
91+
warn("Send " .. triggeringPlayer.Name .. " congratulations about " .. triggeringPlayer.Name .. " clicking on his car show")
8892
end, true) -- Enable monitoring
8993
end)
9094
```

0 commit comments

Comments
 (0)