From c744d74e42733cd5eb1223d4e5888d74b48240b5 Mon Sep 17 00:00:00 2001 From: Ulyssa Date: Thu, 29 Dec 2022 20:25:38 -0800 Subject: [PATCH] Add comparisons table to README (#17) --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/README.md b/README.md index d85869a..e590be1 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,66 @@ You can create a basic configuration in `$CONFIG_DIR/iamb/config.json` that look } ``` +## Comparison With Other Clients + +To get an idea of what is and isn't yet implemented, here is a subset of the +Matrix website's [features comparison table][client-comparison-matrix], showing +two other TUI clients and Element Web: + +| | iamb | [gomuks] | [weechat-matrix] | Element Web/Desktop | +| --------------------------------------- | :----------------- | :----------------: | :----------------: | :-----------------: | +| Room directory | :x: ([#14]) | :x: | :heavy_check_mark: | :heavy_check_mark: | +| Room tag showing | :x: ([#15]) | :heavy_check_mark: | :x: | :heavy_check_mark: | +| Room tag editing | :x: ([#15]) | :heavy_check_mark: | :x: | :heavy_check_mark: | +| Search joined rooms | :x: ([#16]) | :heavy_check_mark: | :x: | :heavy_check_mark: | +| Room user list | :x: ([#6]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Display Room Description | :x: ([#12]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Edit Room Description | :x: ([#12]) | :x: | :heavy_check_mark: | :heavy_check_mark: | +| Highlights | :x: ([#8]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Pushrules | :x: | :heavy_check_mark: | :x: | :heavy_check_mark: | +| Send read markers | :x: ([#11]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Display read markers | :x: ([#11]) | :x: | :x: | :heavy_check_mark: | +| Sending Invites | :x: ([#7]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Accepting Invites | :x: ([#7]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Typing Notification | :x: ([#9]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| E2E | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Replies | :x: ([#3]) | :heavy_check_mark: | :x: | :heavy_check_mark: | +| Attachment uploading | :x: ([#13]) | :x: | :heavy_check_mark: | :heavy_check_mark: | +| Attachment downloading | :x: ([#13]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Send stickers | :x: | :x: | :x: | :heavy_check_mark: | +| Send formatted messages (markdown) | :x: ([#10]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Rich Text Editor for formatted messages | :x: | :x: | :x: | :heavy_check_mark: | +| Display formatted messages | :x: ([#10]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Redacting | :x: ([#5]) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Multiple Matrix Accounts | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: | +| New user registration | :x: | :x: | :x: | :heavy_check_mark: | +| VOIP | :x: | :x: | :x: | :heavy_check_mark: | +| Reactions | :x: ([#2]) | :heavy_check_mark: | :x: | :heavy_check_mark: | +| Message editing | :x: ([#4]) | :heavy_check_mark: | :x: | :heavy_check_mark: | +| Room upgrades | :x: | :heavy_check_mark: | :x: | :heavy_check_mark: | +| Localisations | :x: | 1 | :x: | 44 | +| SSO Support | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | + ## License iamb is released under the [Apache License, Version 2.0]. [Apache License, Version 2.0]: https://github.com/ulyssa/iamb/blob/master/LICENSE +[client-comparison-matrix]: https://matrix.org/clients-matrix/ +[gomuks]: https://github.com/tulir/gomuks +[weechat-matrix]: https://github.com/poljar/weechat-matrix +[#2]: https://github.com/ulyssa/iamb/issues/2 +[#3]: https://github.com/ulyssa/iamb/issues/3 +[#4]: https://github.com/ulyssa/iamb/issues/4 +[#5]: https://github.com/ulyssa/iamb/issues/5 +[#6]: https://github.com/ulyssa/iamb/issues/6 +[#7]: https://github.com/ulyssa/iamb/issues/7 +[#8]: https://github.com/ulyssa/iamb/issues/8 +[#9]: https://github.com/ulyssa/iamb/issues/9 +[#10]: https://github.com/ulyssa/iamb/issues/10 +[#11]: https://github.com/ulyssa/iamb/issues/11 +[#12]: https://github.com/ulyssa/iamb/issues/12 +[#13]: https://github.com/ulyssa/iamb/issues/13 +[#14]: https://github.com/ulyssa/iamb/issues/14 +[#15]: https://github.com/ulyssa/iamb/issues/15 +[#16]: https://github.com/ulyssa/iamb/issues/16