@colibri-social/bridge-discord 0.1.0

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 ADDED
@@ -0,0 +1,25 @@
1
+ # @colibri-social/bridge-discord
2
+
3
+ The Discord connector for [`@colibri-social/bridge-core`](../bridge-core). It relays messages,
4
+ replies, attachments, forwards, edits, deletions, reactions, mentions and public threads
5
+ between Discord channels and Colibri channels, and imports a channel's earlier history when an
6
+ admin asks for it. Colibri users appear in Discord through a
7
+ webhook per channel, with their own name and avatar.
8
+
9
+ ```sh
10
+ npm install @colibri-social/bridge-core @colibri-social/bridge-discord
11
+ ```
12
+
13
+ ```ts
14
+ import { DiscordConnector } from "@colibri-social/bridge-discord";
15
+
16
+ const connector = new DiscordConnector({ token: process.env.DISCORD_TOKEN! });
17
+ ```
18
+
19
+ The bot needs the Message Content privileged intent. In each relayed channel it needs View
20
+ Channel, Send Messages, Read Message History, Manage Webhooks, Add Reactions, Create Public
21
+ Threads, Send Messages in Threads and Manage Threads. Moderation mirroring also needs Manage
22
+ Messages. Server admins pair it with `/colibri connect`.
23
+
24
+ - [Pairing a Bridge](https://colibri.social/docs/bridges/pairing)
25
+ - [Building a Bridge](https://colibri.social/docs/bridges/building-a-bridge)