alemi/aioappsrv
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readmes

Browse source
This commit is contained in:
git-bruh 2021-12-09 13:43:13 +05:30
parent c2f3e97611
commit 84afc8c503
No known key found for this signature in database
GPG key ID: E1475C50075ADCE6
3 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -3,7 +3,8 @@
A simple bridge between Matrix and Discord written in Python. A simple bridge between Matrix and Discord written in Python.
This repository contains two bridges: 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. * A [non-puppeting bridge](bridge): The non-puppeting bridge written with `matrix-nio` and `discord.py`, most people would want to use this one.

1
appservice/README.md
View file

@ -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`). 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: This bridge is written with:
* `bottle`: Receiving events from the homeserver. * `bottle`: Receiving events from the homeserver.
* `urllib3`: Sending requests, thread safety. * `urllib3`: Sending requests, thread safety.
* `websockets`: Connecting to Discord. (Big thanks to an anonymous person "nesslersreagent" for figuring out the initial connection mess.) * `websockets`: Connecting to Discord. (Big thanks to an anonymous person "nesslersreagent" for figuring out the initial connection mess.)

2
bridge/README.md
View file

@ -4,8 +4,6 @@
## Usage ## 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` * Run `bridge.py` to generate `config.json`
* Edit `config.json`: * Edit `config.json`: