Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
better api documentation
less messy
  • Loading branch information
sturmgeisty authored May 13, 2024
1 parent bd670d7 commit 88443ca
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 2,6 @@
<a href="https://github.com/RoSocket/rosocket">
<img width="600" src="https://github.com/RoSocket/rosocket/assets/130825965/f795c24e-dcf0-4fe3-b482-98fe7809e923">
</a>
<br>
<code>RoSocket</code> is a Roblox module to emulate a websocket library.<br>
Http requests must be enabled for the module to work.<br>
To enable them, head over to the topbar > <b>FILE</b> > <b>Game Settings</b> > <b>Security</b> > <b>Allow HTTP Requests</b>.<br>
If you are self-hosting, then navigate to the <b>"Reader"</b> module and change "SOCKET_SERVER_URL" to the URL of your server.
</p>

<p align="center">
Expand Down Expand Up @@ -38,6 33,7 @@ Download from [Releases](https://github.com/RoSocket/rosocket/releases)

## API

For RoSocket to work correctly, you must enable in-game HTTP requests & self-host the server!
If you want faster replies, then navigate to the **reader module** > **SOCKET_SERVER_UPDATES**, set it to 0.10 or less, minimum is 0.02 before ratelimits start to appear.

**Functions:**
Expand Down

0 comments on commit 88443ca

Please sign in to comment.