Skip to content

Commit

Permalink
Doc: update gif to mp4
Browse files Browse the repository at this point in the history
  • Loading branch information
肖健正 committed Jul 14, 2024
1 parent 5d8ba0d commit e86ba58
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Simple neovim plugin for keeping your cursor centered while reading through code/text/whatever

![readermode.gif](readermode.gif)
https://github.com/user-attachments/assets/d9bd8a00-54cd-4264-83a8-2ad4d82d64dc

## Requirements

Expand All @@ -12,25 +12,25 @@ Simple neovim plugin for keeping your cursor centered while reading through code

### lazy.nvim

```lua
{
'sarrisv/readermode.nvim',
opts = { --[[ Configurations Options ]] }
}
```
```lua
{
'sarrisv/readermode.nvim',
opts = { --[[ Configurations Options ]] }
}
```

### Configuration

```lua
{
enabled = false, -- Turned off by default
keymap = "<leader>R" -- Keymap used to toggle ReaderMode on/off
}
```
```lua
{
enabled = false, -- Turned off by default
keymap = "<leader>R" -- Keymap used to toggle ReaderMode on/off
}
```

## Usage

Toggle **ReaderMode** using `:ReaderMode` or the provided *normal mode* keymapping
Toggle **ReaderMode** using `:ReaderMode` or the provided _normal mode_ keymapping

## Credits

Expand Down
Binary file removed readermode.gif
Binary file not shown.

0 comments on commit e86ba58

Please sign in to comment.