Update readme.md

README.md

@@ -6,28 +6,45 @@
 
 PicVim is a Neovim plugin that allows you to view and interact with images directly in Neovim. It supports various image formats such as PNG, JPG, GIF, BMP, and more, offering basic functionality like zooming, rotating, and panning.
 
-### Key Features:
-- 🚀 **Quick Image Viewing:** View images directly in Neovim.
-- 🔄 **Basic Image Interaction:** Zoom, rotate, and pan.
-- 🌐 **Multi-format Support:** Works with PNG, JPG, GIF, BMP, and more.
-
-### ⚠️  Important Notes:
-- 🚫 **Not a replacement for `image.nvim`:** This plugin can't render images in `README.md` files.
-- 🔧 **Early Development:** This is a work in progress, so expect some bugs. Contributions are welcome!
-- 🚫 **Only support for kitty for now:** Only supports kitty graphics but will soon support ueberzugpp too.
-
 ---
 
+# Index
+
+3. [Demo](#demo)
+2. [Key Features](#key-features)
+1. [Project Status and Notes](#notes)
+4. [Usage](#usage)
+5. [Features](#features)
+6. [Installation](#installation)
+7. [Setup](#setup)
+8. [Auto-commands](#autocommands)
+9. [Keybindings](#keybindings)
+10. [Dependencies](#dependencies)
+11. [TODO List](#todo)
+
 ## Demo
 
 
 https://github.com/user-attachments/assets/b8279faa-4e91-4fda-880b-4d4d7cab117d
 
 
+### Key Features:
+- 🚀 **Quick Image Viewing:** View images directly in Neovim.
+- 🔄 **Basic Image Interaction:** Zoom, rotate, and pan.
+- 🌐 **Multi-format Support:** Works with PNG, JPG, GIF, BMP, and more.
+
+
+### ⚠️  Notes:
+- 🔧 **Early Development:** This is a work in progress, so expect some bugs. Contributions are welcome!
+- 🚫 **Not a replacement for `image.nvim`:** This plugin can't render images in `README.md` files.
+- **Only support for kitty:** Only supports kitty graphics.
+
+
 ## 📖 Usage
 
 To use PicVim, simply open an image file in Neovim and the image will be displayed in the buffer. You can interact with the image using the provided keybindings.
 
+
 ## ✨ Features
 
 - View images in Neovim.
@@ -36,18 +53,23 @@ To use PicVim, simply open an image file in Neovim and the image will be display
 - Pan the image using arrow keys or specific keybindings.
 - Automatically scale and adjust images for optimal viewing.
 
+
 ## ⚙️  Installation
 
 Use your prefferred package manager to install PicVim.
 
+
 ### Eg. Using lazy.nvim
 
 If you use [lazy.nvim](https://github.com/folke/lazy.nvim), you can install PicVim by adding the following to your configuration:
 
 ```lua
 {
-    'Toprun123/picvim',
+    "Toprun123/picvim",
-}
+    config = function()
+        require'picvim'.setup()
+    end,
+},
 ```
 
 ## 🔧 Setup
@@ -58,7 +80,7 @@ To activate the plugin, add the following to your init.lua configuration file:
 require'picvim'.setup()
 ```
 
-## 🛠️ Auto-commands
+## 🛠️ Autocommands
 
 The plugin automatically activates for image files (.png, .jpg, .jpeg, .gif, .bmp) upon opening. It sets the buffer to a "non-file" type to display the image correctly.
 
@@ -73,12 +95,13 @@ The plugin automatically activates for image files (.png, .jpg, .jpeg, .gif, .bm
     t – Rotate clockwise (30 degrees).
     T – Rotate counterclockwise (30 degrees).
     o – Reset image position and rotation.
-    r – Redraw the image.
+    r – Rerender the image.
 
 ## 📦 Dependencies
 
 `ImageMagick` for image manipulation.
 `Neovim` 0.5.0 or higher.
+`Kitty` for displaying the image.
 
 ##  TODO:
 
@@ -87,7 +110,6 @@ The plugin automatically activates for image files (.png, .jpg, .jpeg, .gif, .bm
 - [x] Support image rotation.
 - [x] Add support for non-png raster images.
 - [ ] Add support for svg files.
-- [ ] Add support for ueberzugpp.
 - [ ] Make Keybinds configurable.
 - [ ] Expose functions to handle the images.