Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Luis Vasconcellos committed Aug 21, 2016
1 parent ecdf23a commit d8443df
Showing 1 changed file with 8 additions and 17 deletions.
25 changes: 8 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,17 @@
# vim-interestingwords

## What is it?

TL;DR Scroll down for the gifs.

vim-interstingwords is a vim plugin that **highlights** all the occurrences of the word under your cursor. It can be used to highlight **different** words at the same time. To highlight a word you hit ``<Leader>k``.

It also lets you **navigate** these highlighted words using ``n`` and ``N``, just like you would navigate through the results of a search.

## What's the point?
![Screenshot](https://s3-us-west-2.amazonaws.com/vim-interestingwords/interesting-words-1.gif)

This plugin is useful when you are working with a codebase that you are not yet familiar with. In that scenario, highlighting and navigating through different words at the same time can really help you not to get lost on the execution flow.
## What is it?

The idea to build this plugin came from the **@stevelosh** video's where he shows some pretty cool configurations from his .vimrc. He named this configuration interesting words, and I choose to keep the name for this plugin. The video is on youtube: https://www.youtube.com/watch?v=xZuy4gBghho
vim-interstingwords is a vim plugin that **highlights** the occurrences of the word under your cursor in the current buffer. It can be used to highlight **different** words at the same time. It also lets you **navigate** through the highlighted words just like you would navigate through the results of a search.

## Installation

Using vundle, add this to your .vimrc:

```vimscript
Plugin 'vasconcelloslf/vim-interestingwords'
Plugin 'lfv89/vim-interestingwords'
```

Then run:
Expand All @@ -36,24 +28,19 @@ Highlight with ``<Leader>k``

This key will act as a **toggle**, so you can use it to highlight and remove the highlight from a given word. Note that you can highlight different words at the same time.

![Screenshot](https://s3-us-west-2.amazonaws.com/vim-interestingwords/interesting-words-1.gif)

### Navigating Through the Highlighted Words

Navigate with ``n`` and ``N``

Once you have a highlighted word under your cursor, you can **navigate** through the occurrences of this word with ``n`` and ``N``, just as you would if you were using a traditional search.

![Screenshot](https://s3-us-west-2.amazonaws.com/vim-interestingwords/interesting-words-2.gif)

### Clearing all the Highlights

Clear with ``<Leader>K``

Finally, if you don't want to toggle every single highlighted word and want to clear all of them, just hit ``<Leader>K``

![Screenshot](https://s3-us-west-2.amazonaws.com/vim-interestingwords/interesting-words-3.gif)

## Configuration

The plugin comes with those default mapping, but you can change it as you like:
Expand Down Expand Up @@ -86,6 +73,10 @@ Also, if you want to randomise the colors (applied to each new buffer), add this
let g:interestingWordsRandomiseColors = 1
```

## Credits

The idea to build this plugin came from the **@stevelosh** video's where he shows some pretty cool configurations from his .vimrc. He named this configuration interesting words, and I choose to keep the name for this plugin. The video is on youtube: https://www.youtube.com/watch?v=xZuy4gBghho

## Author

[twitter.com/lfv89](http:https://twitter.com/lfv89)
Expand Down

0 comments on commit d8443df

Please sign in to comment.