Skip to content

Commit 749fda2

Browse files
Update plugin directory read me (#2181)
The read me is supposed to describe the plugin subdirectories. This adds documentation for subdirectories added after the read me was last updated. The subdirectories themselves usually have more detailed documentation. While I was here, I capitalized Talon. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent a1afa81 commit 749fda2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

plugin/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
# plugin
22

3-
The plugin folder has several other subfolders containing various commands:
3+
The plugin folder has several other subfolders containing various commands and features:
44

5-
- `cancel` contains commands to make talon ignore a command
5+
- `are_you_sure` lets you require confirmation before executing an action, which can be useful for potentially destructive commands like shutting down your computer or exiting Talon.
6+
- `breaking_changes_notice` notifies the user if the breaking changes file has been updated.
7+
- `cancel` contains commands to make Talon ignore a command
68
- `command_history` has commands to see previous commands
79
- `datetimeinsert` has commands to automatically write the current date and time
810
- `desktops` has commands to navigate between the different computer desktops
911
- `draft_editor` has some of the commands to open and use a built-in pop-up text editor
1012
- `dropdown` has commands to select an option from a dropdown menu
13+
- `gamepad` has default bindings for using a gamepad device to do tasks like clicking, scrolling and moving your cursor.
14+
- `listening_timeout` has a setting for turning off speech recognition if Talon does not detect any commands for the specified number of minutes.
1115
- `macro` has commands to use macros
1216
- `media` has commands for video and volume control
1317
- `microphone_selection` has commands for selecting a microphone to use
1418
- `mode_indicator` does not have commands, but has settings for enabling a graphical mode indicator
1519
- `mouse` has commands to click, drag, scroll, and use an eye tracker
20+
- `new_user_message` shows a message intended for new users.
1621
- `repeater` has commands for repeating other commands, described briefly in the top level [README](https://github.com/talonhub/community?tab=readme-ov-file#repeating-commands)
1722
- `screenshot` has commands for taking screenshots
1823
- `symbols` has commands for inserting certain symbols, like pairs of parentheses or quotation marks
1924
- `talon_draft_window` has the rest of the commands for using the draft editor window
20-
- `talon_helpers` has commands helpful for debugging, opening the talon directory, and getting updates
25+
- `talon_helpers` has commands helpful for debugging, opening the Talon directory, and getting updates
2126
- `text_navigation` has commands for navigating the cursor in text
27+
- `then` has a command that does nothing, which is sometimes useful for command chaining.

0 commit comments

Comments
 (0)