summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 31eeb1d..1398113 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,8 @@
# 1. CrossLink: rule-based intercommunicating framework for BungeeCord and Velocity
CrossLink aims at bridging Minecraft chats and instant messaging platforms.
+CrossLink is a refactor of legacy [BungeeCross](https://github.com/hit-mc/BungeeCross).
+Heavy rewrite has been made to improve software quality.
CrossLink treat every chat area in sub-servers of a Minecraft server group as separate *endpoints*. Different instant
messaging software are different endpoints, too. Server operator create configuration files, which describes how the
@@ -22,6 +24,9 @@ and `forward` into **rules**. Finite rules line up a routing table. CrossLink fo
the routing table. The combination of **actions** is versatile to help build a highly configurable
message forwarding system among Minecraft grouped servers and instant messaging platforms.
+Currently, only Telegram is supported. If you wish to link to other instant messaging platforms,
+implementing that protocol in a *standalone* program is encouraged, which could be linked to CrossLink via `psmb` protocol.
+
# 2. Environment Requirement