diff --git a/README.md b/README.md index ebe7fe7..5afc7a0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# followcursor-mode -Emacs mode to highlight line in other buffer containing word in current buffer +# followcursor-mode - highlight line in other buffer containing word in current buffer + +*Author:* T.v.Dein
+*URL:* [https://github.com/tlinden/followcursor](https://github.com/tlinden/followcursor)
+ +## Screenshot: + +![demo](imgs/followcursor-mode-screencast.gif) + +## Usage: + +To use, first add to your config: + + (require 'followcursor-mode + +Then prepare two windows with different buffers, enable the mode +in one of them with: + + (followcursor-mode) + +Move around in that buffer as you wish. Whenever `point` is on a +match, it will be highlighted in both buffers. + + + diff --git a/imgs/followcursor-mode-screencast.gif b/imgs/followcursor-mode-screencast.gif new file mode 100644 index 0000000..6d70409 Binary files /dev/null and b/imgs/followcursor-mode-screencast.gif differ