Skip to content

Commit f93724f

Browse files
[Chore] Update README.
1 parent fc2717f commit f93724f

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ This will show you all of the core commands that are present in Sublime Merge. S
3131
3. `CommandsBrowser: Browse available plugin/package commands.`
3232
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.
3333

34+
If you want to view the documentation for the package, simply use `CommandsBrowser: View Documentation` which will open the README for the project in your default browser.
35+
3436
**Note:**
3537

3638
1. Since the core command list is not exposed by ST like plugin commands are, the only way to keep track of it would be to manually maintain a list of commands and show it. So, the list is probably incomplete. As far as I know, it should be fairly close to a complete list (It's probably the most comprehensive public list available).
@@ -41,6 +43,13 @@ This package should be upto date with commands as of **ST Build 4122** & **SM Bu
4143

4244
### Settings
4345

46+
`CommandsBrowser` adds several settings for various customizations and filtering of commands which are documented below.
47+
48+
You can change the settings in 2 ways (Both will open the same side by side view for settings).
49+
50+
1. Use `Preferences -> Package Settings -> CommandsBrowser -> Settings` from the main menu.
51+
2. Use `Preferences: CommandsBrowser Settings` from the command palette.
52+
4453
The package ships with necessary helper files for users of [LSP](https://packagecontrol.io/packages/LSP) + [LSP-json](https://packagecontrol.io/packages/LSP-json) to take full advantage of intelligent autocompletions for settings.
4554

4655
##### `auto_open_doc_panel_on_navigate` (`Boolean`)
@@ -102,6 +111,11 @@ The default value for this setting is `"all"` (which is also the only valid stri
102111

103112
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>
104113

114+
You can change the key binding in 2 ways (Both will open the same side by side view for key bindings).
115+
116+
1. Use `Preferences -> Package Settings -> CommandsBrowser -> Key Bindings` from the main menu.
117+
2. Use `Preferences: CommandsBrowser Key Bindings` from the command palette.
118+
105119
## Discussions
106120

107121
[Discussions](https://github.com/Sublime-Instincts/CommandsBrowser/discussions) are enabled for this repo so that constructive discussions can be had on how to effectively use commands (especially core) to improve your ST/SM workflows. Any questions on core commands can be done in the respective channels i.e. [Sublime Text](https://github.com/Sublime-Instincts/CommandsBrowser/discussions/categories/sublime-text-commands) and [Sublime Merge](https://github.com/Sublime-Instincts/CommandsBrowser/discussions/categories/sublime-merge-commands).

0 commit comments

Comments
 (0)