Update README
This commit is contained in:
parent
e46718098a
commit
77adaebbfa
1 changed files with 13 additions and 5 deletions
18
README.md
18
README.md
|
@ -1,10 +1,12 @@
|
||||||
# Trinity
|
# Trinity
|
||||||
WIP Qt5 QML Matrix client
|
A Qt5 QML Matrix client, which supports end-to-end encryption (WIP) and has a Discord-like interface.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
* Basic messaging capabilities
|
* Basic messaging capabilities
|
||||||
* Sending and recieving markdown messages, formatting can be disabled
|
* Sending and recieving markdown messages, formatting can be disabled
|
||||||
* Typing notifications
|
* Typing notifications
|
||||||
|
* End-to-end encryption (WIP)
|
||||||
|
* Community support
|
||||||
* Per-room notification settings
|
* Per-room notification settings
|
||||||
* Listing and joining public rooms
|
* Listing and joining public rooms
|
||||||
* Inviting other members and accepting other people's invites
|
* Inviting other members and accepting other people's invites
|
||||||
|
@ -12,14 +14,20 @@ WIP Qt5 QML Matrix client
|
||||||
* Custom emote support
|
* Custom emote support
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
*Note: This is an outdated screenshot :-)*
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
* Qt5
|
* Qt5
|
||||||
|
* WebEngine is also required
|
||||||
* CMark
|
* CMark
|
||||||
|
* libolm
|
||||||
|
|
||||||
## License
|
## Installation
|
||||||
Trinity's source is distributed under the GPLv3 license. See the `LICENSE` file for more details.
|
You may compile this from source, or use the [PKGBUILD](https://git.sr.ht/~redstrate/pkgbuilds/tree/main/item/trinity/PKGBUILD).
|
||||||
|
|
||||||
`background.jpg` shown on the login page is from Death to Stock.
|
## Licensing
|
||||||
|
Trinity's source code is distributed under the GPLv3 license. See the `LICENSE` file for more details.
|
||||||
|
|
||||||
|
`resources/background.jpg` shown on the login page is from Death to Stock.
|
||||||
|
|
Reference in a new issue