@cloudflare/realtimekit 0.5.0-staging.42 → 0.5.0-staging.44
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 +19 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!-- PROJECT LOGO -->
|
|
2
2
|
<p align="center">
|
|
3
3
|
<a href="https://cloudflare.com">
|
|
4
|
-
<img src="https://cf-assets.www.cloudflare.com/slt3lc6tev37/6EYsdkdfBcHtgPmgp3YtkD/0b203affd2053988264b9253b13de6b3/logo-thumbnail.png" alt="Logo" width="
|
|
4
|
+
<img src="https://cf-assets.www.cloudflare.com/slt3lc6tev37/6EYsdkdfBcHtgPmgp3YtkD/0b203affd2053988264b9253b13de6b3/logo-thumbnail.png" alt="Logo" width="180">
|
|
5
5
|
</a>
|
|
6
6
|
<h3 align="center">RealtimeKit</h3>
|
|
7
7
|
|
|
@@ -48,7 +48,7 @@ A real-time video and audio SDK for building custom, collaborative communication
|
|
|
48
48
|
## Installation
|
|
49
49
|
|
|
50
50
|
```sh
|
|
51
|
-
npm install realtimekit
|
|
51
|
+
npm install @cloudflare/realtimekit
|
|
52
52
|
```
|
|
53
53
|
|
|
54
54
|
|
|
@@ -68,6 +68,22 @@ const meeting = await RealtimeKit.init({
|
|
|
68
68
|
});
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
+
For React you can use the hooks wrapper
|
|
72
|
+
|
|
73
|
+
```ts
|
|
74
|
+
const [meeting, initMeeting] = useRealtimeKitClient();
|
|
75
|
+
useEffect(() => {
|
|
76
|
+
await initMeeting({
|
|
77
|
+
authToken: "<AuthTokenHere>",
|
|
78
|
+
defaults: {
|
|
79
|
+
audio: false,
|
|
80
|
+
video: false,
|
|
81
|
+
}
|
|
82
|
+
});
|
|
83
|
+
}, []);
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
|
|
71
87
|
The `meeting` object is used for all interaction with Cloudflare's servers. For example, the following code snippet is used for a user to join a room.
|
|
72
88
|
|
|
73
89
|
```ts
|
|
@@ -78,7 +94,7 @@ _For more examples, please refer to the [Documentation](https://docs.realtime.cl
|
|
|
78
94
|
|
|
79
95
|
## About
|
|
80
96
|
|
|
81
|
-
|
|
97
|
+
`@cloudflare/realtimekit` is created & maintained by Cloudflare, Inc.
|
|
82
98
|
|
|
83
99
|
The names and logos are trademarks of Cloudflare, Inc.
|
|
84
100
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cloudflare/realtimekit",
|
|
3
|
-
"version": "0.5.0-staging.
|
|
3
|
+
"version": "0.5.0-staging.44",
|
|
4
4
|
"description": "A real-time video and audio SDK for building custom, collaborative communication experiences.",
|
|
5
5
|
"main": "./dist/index.cjs.js",
|
|
6
6
|
"module": "./dist/index.es.js",
|