From d8b960fc3475b7c3e0e4a36c906a2d4358689506 Mon Sep 17 00:00:00 2001
From: shadmansaleh <13149513+shadmansaleh@users.noreply.github.com>
Date: Mon, 20 Sep 2021 22:03:10 +0600
Subject: [PATCH] doc: introduce lua-heredoc for configuring through viml

---
 README.md       | 15 +++++++++++++++
 doc/lualine.txt | 14 ++++++++++++++
 2 files changed, 29 insertions(+)

diff --git a/README.md b/README.md
index dd9ee54..80d4dcf 100644
--- a/README.md
+++ b/README.md
@@ -106,6 +106,21 @@ Lualine has sections as shown below.
 
 Each sections holds it's components e.g. current vim's mode.
 
+<details><summary>Configuring from `.vim` file</summary>
+
+All the examples below are in lua. You can use the same examples
+in `.vim` file by wrapping them in lua heredoc like this:
+
+```vim
+lua << END
+require'lualine'.setup()
+END
+```
+
+checkout `:help lua-heredoc`.
+
+</details>
+
 <details><summary>Default config</summary>
 
 ```lua
diff --git a/doc/lualine.txt b/doc/lualine.txt
index cf28573..b45d615 100644
--- a/doc/lualine.txt
+++ b/doc/lualine.txt
@@ -82,6 +82,20 @@ Lualine has sections as shown below.
 
 Each sections holds it’s components e.g. current vim’s mode.
 
+Configuring from `.vim` file
+
+All the examples below are in lua. You can use the same examples in `.vim` file
+by wrapping them in lua heredoc like this:
+
+>
+    lua << END
+    require'lualine'.setup()
+    END
+<
+
+
+checkout `:help lua-heredoc`.
+
 Default config
 
 >