feat(doc): update read me to 2.0

Author: s1n7ax

README.md

@@ -1,14 +1,28 @@
 # nvim-window-picker
 
-<https://user-images.githubusercontent.com/18459807/161597479-a3d8cf73-3dca-44b1-9eb6-d00b4e6eb842.mp4>
+`hint = 'floating-big-letter'`
+
+`hint = 'statusline-winbar'`
 
 This plugins prompts the user to pick a window and returns the window id of the
-picked window. Part of the code is from
-[nvim-tree](https://github.com/kyazdani42/nvim-tree.lua) so shout out to them
-for coming up with this idea.
+picked window.
 
 ## Install
 
+### lazy
+
+```lua
+{
+    's1n7ax/nvim-window-picker',
+    name = 'window-picker',
+    event = 'VeryLazy',
+    version = '2.*',
+    config = function()
+        require'window-picker'.setup()
+    end,
+}
+```
+
 ### packer
 
 ```lua
@@ -21,8 +35,6 @@ use {
 }
 ```
 
-**Make sure to `:PackerCompile` after installing**
-
 ## How to use
 
 ```lua
@@ -39,25 +51,47 @@ behaviour.
 
 ```lua
 require 'window-picker'.setup({
+    -- type of hints you want to get
+    -- following types are supported
+    -- 'statusline-winbar' | 'floating-big-letter'
+    -- 'statusline-winbar' draw on 'statusline' if possible, if not 'winbar' will be
+    -- 'floating-big-letter' draw big letter on a floating window
+    -- used
+    hint = 'statusline-winbar',
+
     -- when you go to window selection mode, status bar will show one of
     -- following letters on them so you can use that letter to select the window
     selection_chars = 'FJDKSLA;CMRUEIWOQP',
 
-    -- You can change the display string in status bar.
-    -- It supports '%' printf style. Such as `return char .. ': %f'` to display
-    -- buffer filepath. See :h 'stl' for details.
-    selection_display = function(char, windowid)
-        return '%=' .. char .. '%='
-    end,
+    -- This section contains picker specific configurations
+    picker_config = {
+        statusline_winbar_picker = {
+            -- You can change the display string in status bar.
+            -- It supports '%' printf style. Such as `return char .. ': %f'` to display
+            -- buffer file path. See :h 'stl' for details.
+            selection_display = function(char, windowid)
+                return '%=' .. char .. '%='
+            end,
+
+            -- whether you want to use winbar instead of the statusline
+            -- "always" means to always use winbar,
+            -- "never" means to never use winbar
+            -- "smart" means to use winbar if cmdheight=0 and statusline if cmdheight > 0
+            use_winbar = 'never', -- "always" | "never" | "smart"
+        },
+
+        floating_big_letter = {
+            -- window picker plugin provides bunch of big letter fonts
+            -- fonts will be lazy loaded as they are being requested
+            -- additionally, user can pass in a table of fonts in to font
+            -- property to use instead
 
-    -- whether you want to use winbar instead of the statusline
-    -- "always" means to always use winbar,
-    -- "never" means to never use winbar
-    -- "smart" means to use winbar if cmdheight=0 and statusline if cmdheight > 0
-    use_winbar = 'smart', -- "always" | "never" | "smart"
+            font = 'ansi-shadow', -- ansi-shadow |
+        },
+    },
 
     -- whether to show 'Pick window:' prompt
-    show_prompt = false,
+    show_prompt = true,
 
     -- prompt message to show to get the user input
     prompt_message = 'Pick window: ',
@@ -74,7 +108,7 @@ require 'window-picker'.setup({
     filter_func = nil,
 
     -- following filters are only applied when you are using the default filter
-    -- defined by this plugin. if you pass in a function to "filter_func"
+    -- defined by this plugin. If you pass in a function to "filter_func"
     -- property, you are on your own
     filter_rules = {
         -- when there is only one window available to pick from, use that window
@@ -106,28 +140,40 @@ require 'window-picker'.setup({
         file_name_contains = {},
     },
 
-    -- the foreground (text) color of the picker
-    fg_color = '#ededed',
-
-    -- if you have include_current_win == true, then current_win_hl_color will
-    -- be highlighted using this background color
-    current_win_hl_color = '#e35e4f',
-
-    -- all the windows except the curren window will be highlighted using this
-    -- color
-    other_win_hl_color = '#44cc41',
+    -- You can pass in the highlight name or a table of content to set as
+    -- highlight
+    highlights = {
+        statusline = {
+            focused = {
+                fg = '#ededed',
+                bg = '#e35e4f',
+                bold = true,
+            },
+            unfocused = {
+                fg = '#ededed',
+                bg = '#44cc41',
+                bold = true,
+            },
+        },
+        winbar = {
+            focused = {
+                fg = '#ededed',
+                bg = '#e35e4f',
+                bold = true,
+            },
+            unfocused = {
+                fg = '#ededed',
+                bg = '#44cc41',
+                bold = true,
+            },
+        },
+    },
 })
 ```
 
 ```lua
-require(package_name).pick_window({
-    selection_chars = '123345',
-    filter_rules = {
-        include_current_win = true,
-        bo = {
-            filetype = {'markdown'}
-        }
-    },
+require('window-picker').pick_window({
+    hint = 'floating-big-letter'
 })
 ```
 

lua/window-picker/config.lua

@@ -1,8 +1,11 @@
 local config = {
 	-- type of hints you want to get
 	-- following types are supported
-	-- 'statusline-winbar' | 'statusline' | 'floating-big-letter'
-	hint = 'floating-big-letter',
+	-- 'statusline-winbar' | 'floating-big-letter'
+	-- 'statusline-winbar' draw on 'statusline' if possible, if not 'winbar' will be
+	-- 'floating-big-letter' draw big letter on a floating window
+	-- used
+	hint = 'statusline-winbar',
 
 	-- when you go to window selection mode, status bar will show one of
 	-- following letters on them so you can use that letter to select the window