Skip to content

Commit f50ce4b

Browse files
committed
Update README with a gif, start it with a short explanation
1 parent 21defb2 commit f50ce4b

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
[![GitHub version](https://badge.fury.io/gh/andrewradev%2Fswitch.vim.svg)](https://badge.fury.io/gh/andrewradev%2Fswitch.vim)
2-
[![Build Status](https://secure.travis-ci.org/AndrewRadev/switch.vim.svg?branch=master)](http://travis-ci.org/AndrewRadev/switch.vim)
32

4-
## Screencast!
5-
6-
This plugin is easier to demonstrate than explain. You can find a screencast
7-
[here](http://youtu.be/zIOOLZJb87U).
3+
![Demo](http://i.andrewradev.com/116a3b7f45b48186627def8662ffb133.gif)
84

95
## Usage
106

11-
The main entry point of the plugin is a single command, `:Switch`. When the
7+
Demo screencast: <https://www.youtube.com/watch?v=zIOOLZJb87U>
8+
9+
The purpose of the plugin is to switch some text under the cursor based on
10+
regex patterns. The main entry point is a single command, `:Switch`. When the
1211
command is executed, the plugin looks for one of a few specific patterns under
13-
the cursor and performs a substitution depending on the pattern. For example, if
14-
the cursor is on the "true" in the following code:
12+
the cursor and performs a substitution depending on it. For example, if the
13+
cursor is on the "true" in the following code:
1514

1615
``` ruby
1716
flag = true

0 commit comments

Comments
 (0)