summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2018-10-26 14:52:42 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2018-10-26 14:52:42 -0400
commit1efd9df7c56b145691668e161bc446f0e14c7324 (patch)
treec9150dac2445dda29838d6c3ddeb3d2ea2402dd0 /README.md
parentc71fc7188e8c2b652a7cf086bb0978c0a6314144 (diff)
downloadcmd2-git-1efd9df7c56b145691668e161bc446f0e14c7324.tar.gz
Added info on asynchronous alerting capabilities to the README
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 40c58363..2f1a6a04 100755
--- a/README.md
+++ b/README.md
@@ -192,6 +192,16 @@ Instructions for implementing each feature follow.
To create a single-character shortcut for a command, update `Cmd.shortcuts`.
+- Asynchronous alerts based on events happening in background threads
+ - `cmd2` provides the following helper methods for providing information to users asynchronously even though the `cmd2`
+ REPL is a line-oriented command interpreter:
+ - `async_alert` - display an important message to the user while they are at the prompt in between commands
+ - To the user it appears as if an alert message is printed above the prompt
+ - `async_update_prompt` - update the prompt while the user is still typing at it
+ - This is good for alerting the user to system changes dynamically in between commands
+ - `set_window_title` - set the terminal window title
+ - This changes the window title of the terminal that the user is running the `cmd2` app within
+
Tutorials
---------