Update docs to replace curses with tui

README.rst

@@ -36,9 +36,12 @@ Features
 Curses UI
 ---------
 
-toot has an experimental curses based console UI.
+toot includes a curses-based terminal user interface (TUI). Run it with ``toot tui``.
+
+.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/_static/tui_list.png
+
+.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/_static/tui_compose.png
 
-.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/_static/curses.png
 
 License
 -------

docs/index.rst

@@ -46,9 +46,11 @@ Contents
 Curses UI
 ---------
 
-toot has an experimental curses based console UI. Run it with ``toot curses``.
+toot includes a curses-based terminal user interface (TUI). Run it with ``toot tui``.
 
-.. image :: _static/curses.png
+.. image :: _static/tui_list.png
+
+.. image :: _static/tui_compose.png
 
 Development
 -----------

docs/usage.rst

@@ -11,6 +11,7 @@ Running ``toot <command> -h`` shows the documentation for the given command.
     $ toot
 
     toot - a Mastodon CLI client
+    v0.23.0
 
     Authentication:
       toot login           Log into a mastodon instance using your browser (recommended)
@@ -19,15 +20,17 @@ Running ``toot <command> -h`` shows the documentation for the given command.
       toot logout          Log out, delete stored access keys
       toot auth            Show logged in accounts and instances
 
+    TUI:
+      toot tui             Launches the toot terminal user interface
+
     Read:
       toot whoami          Display logged in user details
       toot whois           Display account details
-      toot notifications   Display notifications for logged in user
+      toot notifications   Notifications for logged in user
       toot instance        Display instance details
       toot search          Search for users or hashtags
       toot thread          Show toot thread items
       toot timeline        Show recent items in a timeline (home by default)
-      toot curses          An experimental timeline app (doesn't work on Windows)
 
     Post:
       toot post            Post a status text to your timeline
@@ -56,6 +59,7 @@ Running ``toot <command> -h`` shows the documentation for the given command.
 
     https://github.com/ihabunek/toot
 
+
 Authentication
 --------------
 
@@ -187,14 +191,15 @@ If you get bored of them:
 Using the Curses UI
 ~~~~~~~~~~~~~~~~~~~
 
-toot has an expimental curses based console UI. The command to start it is ``toot curses``.
+toot has a curses-based terminal user interface. The command to start it is ``toot tui``.
 
 To navigate the UI use these commands:
 
 * ``k`` or ``up arrow`` to move up the list of tweets
 * ``j`` or ``down arrow`` to move down the list of tweets
 * ``h`` to show a help screen
-* ``v`` to view the current toot in a browser (this is great for seeing the comment thread on a toot)
+* ``t`` to view status thread
+* ``v`` to view the current toot in a browser
 * ``b`` to boost or unboost a status
 * ``f`` to favourite or unfavourite a status
 * ``q`` to quit the curses interface and return to the command line

setup.py

@@ -6,7 +6,7 @@ long_description = """
 toot is a commandline tool for interacting with Mastodon social networks.
 Allows posting text and media to the timeline, searching, following, muting
 and blocking accounts and other actions.
-Contains an experimental curses application for reading the timeline.
+Includes a curses-based terminal user interface (TUI).
 """
 
 setup(

toot/console.py

@@ -196,6 +196,21 @@ AUTH_COMMANDS = [
     ),
 ]
 
+TUI_COMMANDS = [
+    Command(
+        name="tui",
+        description="Launches the toot terminal user interface",
+        arguments=[],
+        require_auth=False,
+    ),
+    Command(
+        name="curses",
+        description="An experimental timeline app (DEPRECATED, use 'toot tui' instead)",
+        arguments=curses_args,
+        require_auth=False,
+    ),
+]
+
 
 READ_COMMANDS = [
     Command(
@@ -269,18 +284,6 @@ READ_COMMANDS = [
         arguments=timeline_args,
         require_auth=True,
     ),
-    Command(
-        name="curses",
-        description="An experimental timeline app (doesn't work on Windows)",
-        arguments=curses_args,
-        require_auth=False,
-    ),
-    Command(
-        name="tui",
-        description="Launches the TUI (terminal user interface).",
-        arguments=curses_args,
-        require_auth=False,
-    ),
 ]
 
 POST_COMMANDS = [
@@ -445,7 +448,7 @@ ACCOUNTS_COMMANDS = [
     ),
 ]
 
-COMMANDS = AUTH_COMMANDS + READ_COMMANDS + POST_COMMANDS + STATUS_COMMANDS + ACCOUNTS_COMMANDS
+COMMANDS = AUTH_COMMANDS + READ_COMMANDS + TUI_COMMANDS + POST_COMMANDS + STATUS_COMMANDS + ACCOUNTS_COMMANDS
 
 
 def print_usage():
@@ -453,6 +456,7 @@ def print_usage():
 
     groups = [
         ("Authentication", AUTH_COMMANDS),
+        ("TUI", TUI_COMMANDS),
         ("Read", READ_COMMANDS),
         ("Post", POST_COMMANDS),
         ("Status", STATUS_COMMANDS),