Skip to content
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

update readme for plugins #1411

Merged
merged 1 commit into from
Mar 19, 2017
Merged

update readme for plugins #1411

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
25 changes: 23 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ VSCodeVim is a [Visual Studio Code](https://code.visualstudio.com/) extension th
* Marks
* Vim settings similar to those found in .vimrc
* Multi-cursor support. Allows multiple simultaneous cursors to receive Vim commands (e.g. allows `/` search, each cursor has independent clipboards, etc.).
* The EasyMotion plugin!
* The Surround.vim plugin!
* The [EasyMotion plugin](#how-to-use-easymotion)!
* The [Surround.vim plugin](#how-to-use-surround)!
* And much more! Refer to the [roadmap](ROADMAP.md) or everything we support.

Please [report missing features/bugs on GitHub](https://github.com/VSCodeVim/Vim/issues), which will help us get to them faster.
Expand Down Expand Up @@ -261,6 +261,7 @@ Configure the `useCtrlKeys` option (see [configurations#useCtrlKeys](#usectrlkey

#### How to use easymotion

Easymotion is based on [easymotion-vim](https://github.com/easymotion/vim-easymotion)
To activate easymotion, you need to make sure that `easymotion` is set to `true` in settings.json.
Now that easymotion is active, you can initiate motions using the following commands. Once you initiate the motion, text decorators will be displayed and you can press the keys displayed to jump to that position. `leader` is configurable and is `\` by default.

Expand All @@ -277,6 +278,26 @@ Motion Command | Description
`<leader> <leader> b`|Start of word backwards


#### How to use surround

Surround plugin based on tpope's [surround.vim](https://github.com/tpope/vim-surround) plugin is used to work with surrounding characters like parenthesis, brackets, quotes, and XML tags.

t or < as <desired char> or <existing char> will do tags and enter tag entry mode.

Surround Command | Description
---|--------
`d s <existing char>`|Delete existing surround
`c s <existing char> <desired char>`|Change surround existing to desired
`y s <motion> <desired char>`|Surround something with something using motion (as in "you surround")
`S <desired char>`|Surround when in visual modes (surrounds full selection)

Some examples:

* `"test"` with cursor inside quotes type cs"' to end up with `'test'`
* `"test"` with cursor inside quotes type ds" to end up with `test`
* `"test"` with cursor inside quotes type cs"t and enter 123> to end up with `<123>test</123>`
* `test` with cursor on word test type ysaw) to end up with `(test)`

## Contributing

This project is maintained by a group of awesome [people](https://github.com/VSCodeVim/Vim/graphs/contributors) and contributions are extremely welcome :heart:. For a quick tutorial on how you can help, see our [contributing guide](/.github/CONTRIBUTING.md).
Expand Down