ttfm-socket 1.6.9 → 1.6.11
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.
- package/README.md +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Hangout FM Socket Client <!-- omit in toc -->
|
|
2
2
|
|
|
3
|
-
Welcome to the
|
|
3
|
+
Welcome to the Hangout FM Socket Client! This package provides a TypeScript client to communicate with rooms on Hangout FM.
|
|
4
4
|
|
|
5
5
|
- [Installation](#installation)
|
|
6
6
|
- [Joining a Room](#joining-a-room)
|
|
@@ -44,7 +44,7 @@ To join a room, you'll need to retrieve the UUID for that room using [this endpo
|
|
|
44
44
|
import { SocketClient } from "ttfm-socket";
|
|
45
45
|
|
|
46
46
|
const client = new SocketClient("https://socket.prod.tt.fm");
|
|
47
|
-
const token = "{your
|
|
47
|
+
const token = "{your Hangout FM JWT}";
|
|
48
48
|
|
|
49
49
|
const { state } = await client.joinRoom(token, {
|
|
50
50
|
roomUuid: "{room uuid}",
|
|
@@ -214,4 +214,4 @@ Sent by the server after someone hits the `/resetRoom` endpoint for that room. T
|
|
|
214
214
|
|
|
215
215
|
## Support
|
|
216
216
|
|
|
217
|
-
If you have any questions or feedback about this package, please reach out to us on [Discord](https://discord.gg/
|
|
217
|
+
If you have any questions or feedback about this package, please reach out to us on [Discord](https://discord.gg/3AXbhwYTHu) or at help@hangout.fm.
|