docs: Update README.md

README.md

@@ -1,6 +1,10 @@
 # AutoIndent.nvim
 
-A simple util providing auto indent when cursor at the first column and press <TAB>
+A simple util providing auto indent when cursor at the first column and press <tab> like VSCode
+
+
+https://github.com/VidocqH/auto-indent.nvim/assets/16725418/f90b9209-ecde-4f41-9f97-329f5b7ced12
+
 
 ## Installation
 
@@ -15,23 +19,28 @@ requir("lazy").setup({
 })
 ```
 
-### Configuration
+## Configuration
 
 ### Default Config
 
 ```lua
 {
-  lightmode = true    -- Lightmode assumes tabstop and indentexpr not change within buffer's lifetime
-  indentexpr = nil
+  lightmode = true,    -- Lightmode assumes tabstop and indentexpr not change within buffer's lifetime
+  indentexpr = nil,
 }
 ```
 
 ### Custom Indent Evaluate Method
 
+`indentexpr` should be a function returns a number of indents
+
+example using [treesitter.indent](https://github.com/nvim-treesitter/nvim-treesitter#indentation) module
+
 ```lua
 {
-  -- lnum: line number
-  indentexpr = function (lnum)
+  ---@param lnum: number
+  ---@return number
+  indentexpr = function(lnum)
     return require("nvim-treesitter.indent").get_indent(lnum)
   end
 }