Skip to content

Commit 5776528

Browse files
committed
README: Add intentional differences from web client to Feature status.
Fixes #547.
1 parent 17f89bb commit 5776528

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,17 @@ Learn how to use Zulip Terminal with our [Tutorial](https://github.com/zulip/zul
2929

3030
We consider the client to already provide a fairly stable moderately-featureful everyday-user experience.
3131

32+
The terminal client currently has a number of intentional differences to the Zulip web client:
33+
- Additional and occasionally *different* [Hot keys](https://github.com/zulip/zulip-terminal/blob/main/docs/hotkeys.md) to better support keyboard-only navigation; other than directional movement these also include:
34+
- <kbd>z</kbd> - zoom in/out, between streams & topics, or all private messages & specific conversations
35+
- <kbd>t</kbd> - toggle view of topics for a stream in left panel (**later adopted for recent topics in web client**)
36+
- <kbd>#</kbd> - narrow to messages in which you're mentioned (<kbd>@</kbd> is already used)
37+
- <kbd>f</kbd> - narrow to messages you've starred (are **f**ollowing)
38+
- Not marking additional messages read when the end of a conversation is visible ([FAQ entry](https://github.com/zulip/zulip-terminal/blob/main/docs/FAQ.md#when-are-messages-marked-as-having-been-read))
39+
- Emoji and reactions are rendered as text only, for maximum terminal/font compatibility
40+
- Footlinks - footnotes for links (URLs) - make messages readable, while retaining a list of links to cross-reference
41+
- Content previewable in the web client, such as images, are also stored as footlinks
42+
3243
The current development focus is on improving aspects of everyday usage which are more commonly used - to reduce the need for users to temporarily switch to another client for a particular feature.
3344

3445
Current limitations which we expect to only resolve over the long term include support for:

0 commit comments

Comments
 (0)