readme: explain fields

Futarimiti · Oct 2, 2023 · d617763 · d617763
1 parent 273ed8c
commit d617763
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -48,6 +48,24 @@ require('spooky').setup { directory = vim.fn.stdpath('config') .. '/skeletons'
                         }
 ```
 
+To use Telescope for template selection,
+make Telescope a dependency and set `ui.select` to `'telescope'`.
+
+Full description of the options:
+
+| option                  | type    | desc                                                                |
+|-------------------------|---------|---------------------------------------------------------------------|
+| `directory`             | string  | Path to skeletons directory                                         |
+| `case_sensitive`        | boolean | Whether to match skeletons case sensitively (WIP)                   |
+| `auto_use_only`         | boolean | Whether to only use auto-inserted skeletons when only 1 available   |
+| `show_no_template`      | boolean | Whether to show "no template" as a possible choice                  |
+| `ui.select`             | string  | UI to use for selecting templates, one of `builtin` and `telescope` |
+| `ui.prompt`             | string  | Prompt for selecting templates                                      |
+| `ui.previewer_prompt`   | string  | Prompt for previewing templates (Telescope only)                    |
+| `ui.preview_normalised` | boolean | Whether to show normalised template in preview (Telescope only)     |
+| `ui.no_template`        | string  | String for `show_no_template`                                       |
+| `ui.telescope_opts`     | table   | Options to pass to Telescope (Telescope only)                       |
+
 ## Usage
 
 You will put your skeletons in a directory of your choice,