docs(readme): add note on having to set opt = true

nvim-neorocks · Jun 17, 2024 · 9dbcc14 · 9dbcc14
1 parent c6e0be3
commit 9dbcc14
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -65,8 +65,15 @@ and you are good to go!
 
 ### Via `rocks.toml`
 
-With this module installed, you can add the following fields to a `[plugins]` entry
-in your `rocks.toml`:
+With this module installed, you can add the fields that tell `rocks-lazy.nvim`
+how to lazy-load to a `[plugins]` entry in your `rocks.toml`.
+
+> [!IMPORTANT]
+>
+> Because rocks.nvim currently does not have an API to hook into plugin loading[^1],
+> you must set `opt = true` for any plugins you want to lazy-load.
+
+[^1]: This may change as rocks.nvim matures.
 
 #### `event`