docs: add notice about yazi.setup() for directories

mikavilpas · Apr 12, 2024 · 19850ba · 19850ba
1 parent 13aa3e4
commit 19850ba
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -36,9 +36,10 @@ Using lazy.nvim:
   ---@type YaziConfig
   opts = {
     -- Below is the default configuration. It is optional to set these values.
-    --
 
-    -- enable this if you want to open yazi instead of netrw
+    -- enable this if you want to open yazi instead of netrw.
+    -- Note that if you enable this, you need to call yazi.setup() to
+    -- initialize the plugin.
     open_for_directories = false,
 
     -- the path to a temporary file that will be created by yazi to store the