Skip to content
This repository has been archived by the owner on Jul 2, 2021. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Closes psliwka#22
  • Loading branch information
subnut committed Nov 23, 2020
1 parent 94a4c39 commit 0413d91
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
vim-smoothie: Smooth scrolling for Vim done right🥤
vim-smoothie: Smooth scrolling for Vim done right :cup_with_straw:
===================================================

This (neo)vim plugin makes scrolling nice and _smooth_. Find yourself
Expand Down Expand Up @@ -30,6 +30,20 @@ adjusting one or more of the following variables in your `vimrc`:
supposed to bind keys you like by yourself. See `plugin/smoothie.vim` to
discover available mappings.

* `g:smoothie_enabled`: Set it to `0` to disable vim-smoothie. Useful for
extremely slow connections.

* `g:smoothie_base_speed`: Controls the speed. Set to `10` by default. To
go slower, reduce the value. To go faster, increase the value.

* `g:smoothie_update_interval`: Time interval (in milliseconds) between
successive screen updates. Use a smaller value to get smoother
animations, or use a bigger value if you are on a slow connection.

* `g:smoothie_break_on_reverse`: If true, then scrolling will stop
immediately when a command is given to scroll opposite to the current
direction.

Alternatives, a.k.a. why create yet another plugin
--------------------------------------------------

Expand Down Expand Up @@ -65,7 +79,6 @@ replaces. That is, every command should still behave exactly as described in
`:help scroll.txt`. There are still some deviations from the origial behavior,
which hopefully will be addressed in the future:

* `^D`, `^U`, `^F`, `^B` should beep when they can't move any further.
* `^F` and `^B` should respect the `window` option.
* Native commands may move in a smarter way over wrapped/folded lines.

Expand Down

0 comments on commit 0413d91

Please sign in to comment.