Merge pull request #27 from mistweaverco/feat/docs

feat(docs): clarify a lot of things
mistweaverco · Jul 4, 2024 · 82f6364 · 82f6364
2 parents 442d136 + a79aa02
commit 82f6364
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,9 @@ It allows you to make HTTP requests from within Neovim.
 
 ## Install
 
+> [!WARNING]
+> Requires Neovim 0.10.0+
+
 Via [lazy.nvim](https://github.com/folke/lazy.nvim):
 
 ### Configuration
@@ -47,18 +50,22 @@ require('lazy').setup({
         default_env = "dev",
         -- enable/disable debug mode
         debug = false,
-        inlay = {
-          loading_icon = "⏳",
-          done_icon = "✅ "
-        },
-        lualine = {
-          icon = "🐼"
+        -- default formatters for different content types
+        formatters = {
+          json = { "jq", "." },
+          xml = { "xmllint", "--format", "-" },
+          html = { "xmllint", "--format", "--html", "-" },
         },
+        -- default icons
+        icons = {
+          inlay = {
+            loading = "⏳",
+            done = "✅ "
+          },
+          lualine = "🐼",
+        }
       })
     end
   },
 })
 ```
-
-> [!WARNING]
-> Requires Neovim 0.10.0+
diff --git a/docs/install.md b/docs/install.md
@@ -1,7 +1,9 @@
 ## Install
 
-Via [lazy.nvim](https://github.com/folke/lazy.nvim):
+> [!WARNING]
+> Requires Neovim 0.10.0+
 
+Via [lazy.nvim](https://github.com/folke/lazy.nvim):
 
 ### Simple configuration
 
@@ -19,6 +21,20 @@ require('lazy').setup({
         default_env = "dev",
         -- enable/disable debug mode
         debug = false,
+        -- default formatters for different content types
+        formatters = {
+          json = { "jq", "." },
+          xml = { "xmllint", "--format", "-" },
+          html = { "xmllint", "--format", "--html", "-" },
+        },
+        -- default icons
+        icons = {
+          inlay = {
+            loading = "⏳",
+            done = "✅ "
+          },
+          lualine = "🐼",
+        }
       })
     end
   },

diff --git a/lua/kulala/config/init.lua b/lua/kulala/config/init.lua
@@ -6,18 +6,19 @@ KULALA_CONFIG = KULALA_CONFIG or {
   default_env = "dev",
   -- enable/disable debug mode
   debug = false,
-  -- formatters
+  -- default formatters for different content types
   formatters = {
     json = { "jq", "." },
     xml = { "xmllint", "--format", "-" },
     html = { "xmllint", "--format", "--html", "-" },
   },
+  -- default icons
   icons = {
     inlay = {
       loading = "⏳",
       done = "✅ "
     },
-    lualine = "🐼"
+    lualine = "🐼",
   }
 }