@liveblocks/chat-sdk-adapter 0.0.0 → 3.16.0-flow2
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 +57 -0
- package/dist/index.cjs +972 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +67 -0
- package/dist/index.d.ts +67 -0
- package/dist/index.js +972 -0
- package/dist/index.js.map +1 -0
- package/package.json +62 -2
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
<p>
|
|
2
|
+
<a href="https://liveblocks.io#gh-light-mode-only"><img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-light.svg" alt="Liveblocks" /></a>
|
|
3
|
+
<a href="https://liveblocks.io#gh-dark-mode-only"><img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-dark.svg" alt="Liveblocks" /></a>
|
|
4
|
+
</p>
|
|
5
|
+
|
|
6
|
+
# `@liveblocks/chat-sdk-adapter`
|
|
7
|
+
|
|
8
|
+
<p>
|
|
9
|
+
<a href="https://npmjs.org/package/@liveblocks/chat-sdk-adapter"><img src="https://img.shields.io/npm/v/@liveblocks/chat-sdk-adapter?style=flat&label=npm&color=c33" alt="NPM" /></a>
|
|
10
|
+
<a href="https://bundlephobia.com/package/@liveblocks/chat-sdk-adapter"><img src="https://img.shields.io/bundlephobia/minzip/@liveblocks/chat-sdk-adapter?style=flat&label=size&color=09f" alt="Size" /></a>
|
|
11
|
+
<a href="https://github.com/liveblocks/liveblocks/blob/main/licenses/LICENSE-APACHE-2.0"><img src="https://img.shields.io/badge/license-Apache--2.0-green" alt="License" /></a>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
`@liveblocks/chat-sdk-adapter` is a [Chat SDK](https://chat-sdk.dev) platform
|
|
15
|
+
adapter backed by [Liveblocks](https://liveblocks.io) **Comments**. It maps
|
|
16
|
+
rooms, threads, and comments to the Chat SDK’s `Channel` / `Thread` / `Message`
|
|
17
|
+
model so you can build bots that read and post in Liveblocks comment threads.
|
|
18
|
+
|
|
19
|
+
## Installation
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
npm install @liveblocks/chat-sdk-adapter chat
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Documentation
|
|
26
|
+
|
|
27
|
+
Read the
|
|
28
|
+
[documentation](https://liveblocks.io/docs/api-reference/liveblocks-chat-sdk-adapter)
|
|
29
|
+
for guides and API references.
|
|
30
|
+
|
|
31
|
+
## Examples
|
|
32
|
+
|
|
33
|
+
Explore our [collaborative examples](https://liveblocks.io/examples) to help you
|
|
34
|
+
get started.
|
|
35
|
+
|
|
36
|
+
> All examples are open-source and live in this repository, within
|
|
37
|
+
> [`/examples`](../../examples).
|
|
38
|
+
|
|
39
|
+
## Releases
|
|
40
|
+
|
|
41
|
+
See the [latest changes](https://github.com/liveblocks/liveblocks/releases) or
|
|
42
|
+
learn more about
|
|
43
|
+
[upcoming releases](https://github.com/liveblocks/liveblocks/milestones).
|
|
44
|
+
|
|
45
|
+
## Community
|
|
46
|
+
|
|
47
|
+
- [Discord](https://liveblocks.io/discord) - To get involved with the Liveblocks
|
|
48
|
+
community, ask questions and share tips.
|
|
49
|
+
- [X](https://x.com/liveblocks) - To receive updates, announcements, blog posts,
|
|
50
|
+
and general Liveblocks tips.
|
|
51
|
+
|
|
52
|
+
## License
|
|
53
|
+
|
|
54
|
+
Licensed under the Apache License 2.0, Copyright © 2021-present
|
|
55
|
+
[Liveblocks](https://liveblocks.io).
|
|
56
|
+
|
|
57
|
+
See [LICENSE](../../licenses/LICENSE-APACHE-2.0) for more information.
|