docs: improved README.md defaults (#20)

Author: DrKJeff16

README.md

@@ -2,27 +2,29 @@
 
 # fzf-nerdfont.nvim
 
-A Neovim plugin that provides a handy way to search
-and insert Nerd Font icons<br />using [`ibhagwan/fzf-lua`](https://github.com/ibhagwan/fzf-lua)
-while you edit.
 <br />
 
-![Example GIF](https://raw.githubusercontent.com/stephansama/static/refs/heads/main/nvim-plugins/fzf-nerdfont.gif)
+[![Example GIF](https://raw.githubusercontent.com/stephansama/static/refs/heads/main/nvim-plugins/fzf-nerdfont.gif)](#)
+
+A Neovim plugin that provides a handy way to search
+and insert Nerd Font icons<br />using [`ibhagwan/fzf-lua`](https://github.com/ibhagwan/fzf-lua) while editing.
 
 </div>
 
-## ☄ Getting started
+---
+
+## ☄ Getting Started
 
 This plugin provides a command `FzfNerdFont` that opens a `fzf-lua` window
 with a list of Nerd Font icons.
-You can search for an icon and press enter to insert it into the current buffer.
+You can search for an icon and press `Enter` to insert it into the current buffer.
 
-### Prerequisites
+### Requirements
 
+- [`Neovim`](https://github.com/neovim/neovim) **(`v0.11` or later)**
 - [`fzf`](https://github.com/junegunn/fzf)
-- [`jq`](https://github.com/jqlang/jq)
-- [`make`](https://www.gnu.org/software/make/)
-- [`neovim >0.11`](https://github.com/neovim/neovim)
+- [`jq`](https://github.com/jqlang/jq) **(for regenerating glyphs)**
+- [`GNU make`](https://www.gnu.org/software/make/)
 
 ### 📋 Installation
 
@@ -39,43 +41,52 @@ require("lazy").setup({
         cmd = "FzfNerdfont",
         keys = {
             { "<leader>fi", "<CMD>FzfNerdfont<CR>", desc= "Open fzf nerd font picker" }
-        }
+        },
+        ---@module 'fzf-nerdfont'
+        ---@type FzfNerdFontOpts
+        opts = {}
       }
     }
 })
 ```
 
+---
+
 ## ⚙ Configuration
 
 > [!NOTE]
-> The options are also available in Neovim by calling `:h fzf-nerdfont.options`
+> The options are also available in Neovim by running `:h fzf-nerdfont.options`.
 
 <details>
-<summary>Click to unfold the full list of options with their default values</summary>
+<summary><b>Click to unfold the full list of options with their default values</b></summary>
 
 ```lua
-require("fzf-nerdfont").setup({
-    -- you can copy the full list from lua/fzf-nerdfont/config.lua
-})
+---@type FzfNerdFontOpts
+{
+  debug = false, -- Debugging
+  glyphs_dir = vim.fn.stdpath("data") .. "/fzf-nerdfont", -- The directory in which glyphs will be saved
+  prompt = "Select Icon>", -- The fzf-lua prompt
+}
 ```
 
 </details>
 
+---
+
 ## 🧰 Commands
 
-|   Command   |         Description        |
-|-------------|----------------------------|
-|  `:FzfNerdfont`  |     Shows the Nerd Font icon list with fzf-lua.    |
-|  `:FzfNerdfont generate`  |     Generates the Nerd Font icon list.    |
-|  `:FzfNerdfont delete`  |     Deletes the generated Nerd Font icon list.    |
-|  `:FzfNerdfont run`  |     Shows the Nerd Font icon list with fzf-lua (same as no arguments).    |
+|   Command                 |  Description                                                           |
+|---------------------------|------------------------------------------------------------------------|
+|  `:FzfNerdfont`           |  Shows the Nerd Font icon list with `fzf-lua`.                         |
+|  `:FzfNerdfont generate`  |  Generates the Nerd Font icon list.                                    |
+|  `:FzfNerdfont delete`    |  Deletes the generated Nerd Font icon list.                            |
+|  `:FzfNerdfont run`       |  Shows the Nerd Font icon list with `fzf-lua` (same as no arguments).  |
 
 ---
 
 ## FAQ
 
-1. _**How to use this plugin from within insert mode?**_
-
+- _**How do I use this plugin from within insert mode?**_
   ```lua
   local function insert_fzf_nerdfont()
     vim.cmd.stopinsert()
@@ -88,12 +99,16 @@ require("fzf-nerdfont").setup({
   })
   ```
 
+---
+
 ## ⌨ Contributing
 
-PRs and issues are always welcome. Make sure to provide as much context as possible when opening one.
+PRs and issues are always welcome.
+Make sure to provide as much context as possible when opening one.
 
 ## Special Thanks
 
-A very special thanks to [DrKJeff16](https://github.com/DrKJeff16/) for helping me with the initial setup of this plugin.
+A very special thanks to [DrKJeff16](https://github.com/DrKJeff16) for helping me
+with the initial setup of this plugin.
 
 And a special thank you to [fzf-lua](https://github.com/ibhagwan/fzf-lua).