Skip to content

Update README.md to include getting started #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anchepiece wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md to include getting started #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Space Block Jumper

Space Block Jumper helps you navigate through space-delimited blocks.
Space Block Jumper is a [Visual Studio Code](https://code.visualstudio.com/) extension that helps you navigate through space-delimited blocks of text.

![Demo](./demo.gif?raw=true "Demo")

Expand All @@ -11,6 +11,30 @@ Space Block Jumper helps you navigate through space-delimited blocks.
* `spaceBlockJumper.selectUp`: Select up a space block (often `shift+ctrl+up`)
* `spaceBlockJumper.selectDown`: Select down a space block (often `shift+ctrl+down`)


## Getting started

This plugin will be automatically enabled after [installing](https://marketplace.visualstudio.com/items?itemName=jmfirth.vsc-space-block-jumper) it and reloading.

### Keyboard shortcuts

Changes to your key bindings can be made using the **Keyboard Shortcuts** editor by **Preferences** > **Keyboard Shortcuts**. Open the **keybindings.json** user preferences document to edit your bindings using the below for reference.

```
// Place your key bindings in this file to overwrite the defaults
[
{ "key": "ctrl+up", "command": "spaceBlockJumper.moveUp",
"when": "editorTextFocus" },
{ "key": "ctrl+down", "command": "spaceBlockJumper.moveDown",
"when": "editorTextFocus" },
{ "key": "shift+ctrl+up", "command": "spaceBlockJumper.selectUp",
"when": "editorTextFocus" },
{ "key": "shift+ctrl+down", "command": "spaceBlockJumper.selectDown",
"when": "editorTextFocus" }
]
```


## Known Issues

None at this time.
Expand Down