Skip to content

Commit

Permalink
[Chore] Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
UltraInstinct05 committed Nov 23, 2021
1 parent 39f8587 commit 9613265
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ If you are interested in contributing to this repository, then you need to follo

This package provides 3 items to the command palette.
1. `CommandsBrowser: Browse available Sublime Text core commands.`
This will show you all of the core commands that are present in Sublime Text. Selecting one would bring up a panel that would show the documentation for that command.
This will show you all of the core commands that are present in Sublime Text. Selecting one would bring up a panel that would show the documentation for that command. You can also hold down <kbd>ctrl</kbd> while selecting a command to copy it's signature to clipboard.
2. `CommandsBrowser: Browse available Sublime Merge core commands.`
This will show you all of the core commands that are present in Sublime Merge. Selecting one would bring up a panel that would show the documentation for that command.
This will show you all of the core commands that are present in Sublime Merge. Selecting one would bring up a panel that would show the documentation for that command. You can also hold down <kbd>ctrl</kbd> while selecting a command to copy it's signature to clipboard.
3. `CommandsBrowser: Browse available plugin/package commands.`
This will show you all of the plugin/package commands that are present in Sublime Text. Selecting one would open the corresponding plugin file & navigate to that location where the command class is implemented.

Expand Down Expand Up @@ -87,6 +87,17 @@ For a list of valid modifier key values, see https://www.sublimetext.com/docs/ap

The default value for this setting is `"ctrl"`.

##### `filter_plugin_commands_on_package` (`str | List[str]`)

This setting allows a user to filter the plugin commands based on the package name.

Examples:
1. `"all"` - Shows all plugin commands.
2. `["PackageDev"]` - Show only `PackageDev` commands.
2. `["User", "OverrideAudti"]` - Show `OverrideAudit` & `User` commands.

The default value for this setting is `"all"` (which is also the only valid string value this setting can take).

### Key bindings.

This package just ships with one key binding to make it easier to open the core commands documentation panel (If it exists). The key binding for that is <kbd>ctrl + shift + c, ctrl + shift + d</kbd>
Expand Down

0 comments on commit 9613265

Please sign in to comment.