From c5f31f5677fdc254919a53976a3968dfbc92de0d Mon Sep 17 00:00:00 2001
From: Alexander Nortung <alexander.nortung@oakdigital.dk>
Date: Sat, 4 Mar 2023 02:26:13 +0000
Subject: [PATCH] Added caveat section to options (#222)

Since the options set could be treated as options for a module, it
should be wrapped with config to work, when using makeNixvimWithModule.
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index e7cf5b6f..99e7190e 100644
--- a/README.md
+++ b/README.md
@@ -263,6 +263,20 @@ All of these are configurable from within NixVim. All you have to do is set the
 Please note that to, for example, disable numbers you would not set
 `options.nonumber` to true, you'd set `options.number` to false.
 
+### Caveats
+
+If you are using `makeNixvimWithModule`, then options is treated as options for a module. To get around this just wrap the options in a `config` set.
+
+```nix
+{
+  config = {
+    options = {
+      # ...
+    };
+  };
+}
+```
+
 ## Key mappings
 It is fully possible to define key mappings from within NixVim. This is done
 using the `maps` attribute: