@colibri-social/bridge-core 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,19 @@
1
+ # @colibri-social/bridge-core
2
+
3
+ Connects a Colibri community to another chat service. It handles the Colibri side of a
4
+ bridge: service auth, the AppView event stream, message mapping, echo suppression, and
5
+ conversion between Markdown and Colibri facets. You write a connector for the other service.
6
+
7
+ ```sh
8
+ npm install @colibri-social/bridge-core
9
+ ```
10
+
11
+ ## Documentation
12
+
13
+ - [Bridges](https://colibri.social/docs/bridges/overview): what a bridge does and how bridged messages appear
14
+ - [Pairing a Bridge](https://colibri.social/docs/bridges/pairing): connect a bridge to a community and link channels
15
+ - [Building a Bridge](https://colibri.social/docs/bridges/building-a-bridge): write and run a connector
16
+ - [Bridge Reference](https://colibri.social/docs/bridges/reference): every method, field, limit and error
17
+
18
+ `packages/bridge-discord` and `apps/bridge` in this repository hold the Colibri bridge for
19
+ Discord, built on this package.