From d2cea5e9b7ab39bc0d585d0c18c5c2d5999e3b61 Mon Sep 17 00:00:00 2001
From: Tuure <tuure.piitulainen@gmail.com>
Date: Wed, 24 Jul 2024 00:46:05 +0300
Subject: [PATCH] Add options in README

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 13b0ed3..1fe5431 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,16 @@ NeoVim is supported.
 - all open viewers automatically scroll to keep in sync with your cursor in Vim
 - open the current buffer's contents in vivify with `:Vivify`
 
+## Configuration
+
+- `g:vivify_instant_refresh = 1`
+    - refresh page contents on `TextChanged` and `TextChangedI` (default)
+- `g:vivify_instant_refresh = 0`
+    - refresh page contents on `CursorHold` and `CursorHoldI`
+- `g:vivify_filetypes`
+    - additional filetypes to recognize as markdown
+    - for example `let g:vivify_filetypes = ['vimwiki']`
+
 ## Installation
 
 With [vivify](https://github.com/jannis-baum/vivify) installed in your PATH, you