readme

README.md

@@ -1,6 +1,6 @@
 ## guard.nvim
 
-Async formatting and linting utility for neovim. 
+Async formatting and linting utility for neovim.
 
 ## Features
 
@@ -49,12 +49,9 @@ require('guard').setup({
 })
 ```
 
-Use `GuardFmt` to manually call format, use `GuardDisable` to diable auto format. and you can create
-a keymap like
-
-```lua
-vim.keymap.set({'n','v'}, '<cmd>GuardFmt<CR>')
-```
+- Use `GuardFmt` to manually call format, when there is a visual selection only the selection is formatted.
+- Use `GuardDisable` to disable auto format, you can also disable for certain filetypes or buffers by using `GuardDisable lua` or `GuardDisable 1` (0 for current buffer)
+- Use `GuardEnable` to re-enable auto format, usage is the same as `GuardDisable`
 
 ### Builtin tools
 
@@ -74,16 +71,17 @@ Table format for custom tool:
 
 ```
 {
-    cmd              --string tool command
-    args             --table command arugments
-    fname            --string insert filename to args tail
-    stdin            --boolean pass buffer contents into stdin
-    timeout          --integer
-    ignore_pattern   --table ignore run format when pattern match
-    ignore_error     --when has lsp error ignore format
+    cmd              -- string: tool command
+    args             -- table: command arugments
+    fname            -- string: insert filename to args tail
+    stdin            -- boolean: pass buffer contents into stdin
+    timeout          -- integer
+    ignore_pattern   -- table: ignore run format when pattern match
+    ignore_error     -- boolean: when has lsp error ignore format
+    find             -- string: format if the file is found in the lsp root dir
 
     --special
-    fn       --function if fn is set other field will not take effect
+    fn       -- function: if fn is set other field will not take effect
 }
 ```
 
@@ -95,6 +93,6 @@ Table format for custom tool:
 
 ## Troubleshooting
 
-if guard does not auto format on save, run `checkhealth` first.
+If guard does not auto format on save, run `checkhealth` first.
 
 ## License MIT