From fbdd21555cf1e7a6c2de26724a12600e13f5a549 Mon Sep 17 00:00:00 2001
From: Fabrizio Damicelli <fabridamicelli@gmail.com>
Date: Thu, 2 May 2024 22:17:45 +0200
Subject: [PATCH] add docu in readme to install/setup using vim-plug

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

diff --git a/README.md b/README.md
index db461fc..3ae5db7 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,15 @@ return {
 }
 ```
 
+Using [vim-plug](https://github.com/junegunn/vim-plug)
+
+```viml
+Plug 'fabridamicelli/cronex.nvim'
+
+lua <<EOF
+require("cronex").setup({})
+EOF
+```
 
 ## Usage
 Calling setup makes the explainer available and set explanations when leaving insert mode.  
@@ -102,6 +111,18 @@ require("cronex").setup({
 })
 ```
 
+To embed the above configuration code snippet in a `.vim` file
+(for example in `init.vim`),
+wrap it in `lua << EOF code-snippet EOF`:
+
+```lua
+lua << EOF
+require('cronex').setup{
+  -- ...
+}
+EOF
+```
+
 ### Extractor
 Logic of the default extractor can be found here in `/cronex/cron_from_line.lua`.  
 Default extractor searches for at most 1 expression per line of length 7, 6 or 5 (in that order).