From 84afc8c503b87e9c93587280027fdfced7bf27af Mon Sep 17 00:00:00 2001 From: git-bruh Date: Thu, 9 Dec 2021 13:43:13 +0530 Subject: [PATCH] update readmes --- README.md | 3 ++- appservice/README.md | 1 + bridge/README.md | 2 -- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2c49c0a..ff157f8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ A simple bridge between Matrix and Discord written in Python. This repository contains two bridges: -* A [puppeting appservice](appservice) (experimental-ish): The puppeting bridge written with minimal dependencies. Running this requires a self-hosted homeserver. + +* A [puppeting appservice](appservice): The puppeting bridge written with minimal dependencies. Running this requires a self-hosted homeserver. * A [non-puppeting bridge](bridge): The non-puppeting bridge written with `matrix-nio` and `discord.py`, most people would want to use this one. diff --git a/appservice/README.md b/appservice/README.md index e5b0310..0399257 100644 --- a/appservice/README.md +++ b/appservice/README.md @@ -89,6 +89,7 @@ Eg. Running `python3 main.py /path/to/my/dir` will store the database and logs i After setting up the bridge, send a direct message to `@appservice-discord:domain.tld` containing the channel ID to be bridged (`!bridge 123456`). This bridge is written with: + * `bottle`: Receiving events from the homeserver. * `urllib3`: Sending requests, thread safety. * `websockets`: Connecting to Discord. (Big thanks to an anonymous person "nesslersreagent" for figuring out the initial connection mess.) diff --git a/bridge/README.md b/bridge/README.md index c70c5e4..f6fe32c 100644 --- a/bridge/README.md +++ b/bridge/README.md @@ -4,8 +4,6 @@ ## Usage -**Disclaimer:** This was one of the author's first non-trivial projects with Python, so code quality is not too good. The appservice has much better code. - * Run `bridge.py` to generate `config.json` * Edit `config.json`: