diff --git a/docs/img/icon.png b/docs/img/icon.png new file mode 100644 index 0000000..0de58b6 Binary files /dev/null and b/docs/img/icon.png differ diff --git a/readme.md b/readme.md index 447e6f1..77239f7 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,15 @@ # Out Of Your Element + + Modern Matrix-to-Discord appservice bridge. Created by [@cadence:cadence.moe](https://matrix.to/#/@cadence:cadence.moe) // Discuss in [#out-of-your-element:cadence.moe](https://matrix.to/#/#out-of-your-element:cadence.moe) +## Docs + +This readme has the most important info. The rest is [in the docs folder.](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs) + ## Why a new bridge? * Modern: Supports new Discord features like replies, threads and stickers, and new Matrix features like edits, spaces and space membership. @@ -44,10 +50,6 @@ For more information about features, [see the user guide.](https://gitdab.com/ca * This bridge is not designed for puppetting. * Direct Messaging is not supported yet. -## Documentation - -The most important information is here in the readme. The rest is [in the docs folder.](https://gitdab.com/cadence/out-of-your-element/src/branch/main/docs) - ## Efficiency details Using WeatherStack as a thin layer between the bridge application and the Discord API lets us control exactly what data is cached. Only necessary information is cached. For example, member data, user data, message content, and past edits are never stored in memory. This keeps the memory usage low and also prevents it ballooning in size over the bridge's runtime. @@ -93,7 +95,7 @@ Follow these steps: * $ `npm run addbot` * $ `./addbot.sh` -# Development information +# Development setup * Be sure to install dependencies with `--save-dev` so you can run the tests. * Any files you change will automatically be reloaded, except for `stdin.js` and `d2m/discord-*.js`.