Skip to content

Commit 81dbd3e

Browse files
authored
Update README.md
1 parent 9546292 commit 81dbd3e

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,24 @@ An event is fired when a player reaches this, regardless of whether `kick_on_max
1414

1515
See more about events and settings below.
1616

17-
**Note**: all the functions and events listed below are serverside unless otherwise stated.
18-
1917
 
2018

2119
## Getting Started
2220

23-
Download the repo and extract it to your server resources folder and start it, like you would with any other resource.
21+
If you're experienced, you can integrate this resource directly into your own, however for basic usage it's best to keep things separate and use exports as explained below.
2422

25-
 
23+
Download the repo and extract the contents to a folder in your server's resources, like you would with any other resource.
24+
25+
For this example we'll assume you named the resource `conguard`. To create a ConGuard instance, use the following export in **your own resource**:
2626

27-
For this example we'll assume your resource folder is called `conguard`. To create a ConGuard instance, use the following:
27+
### Note: all functions/exports and events listed here are serverside only, unless otherwise stated
2828

2929
```lua
3030
exports.conguard:createConnectionGuard(int dimension [, table settings])
3131
```
3232

33+
**Note**: If you want to create a global instance (running in all dimensions) then pass `-1` as the dimension. If an instance already exists in a specific dimension, it will take precedence over the global instance.
34+
3335
 
3436

3537
You can turn a ConGuard instance on or off, temporarily:
@@ -46,9 +48,6 @@ You can also destroy a ConGuard instance entirely by doing:
4648
exports.conguard:destroyConnectionGuard(int dimension)
4749
```
4850

49-
**Note**: If you want to create a global instance (running in all dimensions) then pass `-1` as the dimension.
50-
If an instance already exists in a specific dimension, it will take precedence over the global instance.
51-
5251
 
5352

5453
### Events

0 commit comments

Comments
 (0)