From 53921c4f2b2ef868b1bed70bc11ab330b0ad4a47 Mon Sep 17 00:00:00 2001
From: Tim Keller <tjkeller.xyz>
Date: Thu, 28 Nov 2024 11:53:51 -0600
Subject: readme updated and minitab fixed

---
 README.md | 46 ++++++++++++++++++++++++++++++++--------------
 1 file changed, 32 insertions(+), 14 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index bf7d914..fdf4c96 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,48 @@
 # minitab.nvim
 
-Fork of
+Minitab is a minimal lua reimplementaion of the tabline render function with
+some improvements.
+It consists of only ~80 lines of code.
+
+Minitab started as a fork of
 [`alvarosevilla95/luatab.nvim`](https://github.com/alvarosevilla95/luatab.nvim)
 
 ## Features
-* Just a lua rewrite of the tabline render function
-* No weird mixing buffers and tabs stuff
-* Size/position of tabs doesn't change
+* Text only rendering
+* Size/position of tabs doesn't change while switching between them
+* File paths are not shown
+* Smart handling of module files (e.g. `init.lua` => `module/init.lua`)
+
+## Example bar
+` +2 README.md | minitab/init.lua | + [No Name] | ~/docs/src/ | newrw | zsh | TelescopePrompt `
+
+The above text demonstrates or less what you can expect from this plugin's
+default tabline rendering.
 
 ## Install
-Using [`lazy.nvim`](https://github.com/folke/lazy.nvim)
+Using a [`lazy.nvim`](https://github.com/folke/lazy.nvim) module
 ```lua
 return { url = 'https://git.tjkeller.xyz/minitab.nvim', config = true }
 ```
 
 ## Configuration
-
-The plugin calls the `helpers.tabline` function to render the line. It uses the other functions defined in `helpers`, such as `cell,separator,devicon`.
-You can pass overrides for any of these functions in `setup`. Please see `lua/minitab/init.lua` for details.
+The plugin calls the `helpers.tabline` function to render the line.
+It uses the other functions and constants defined in `helpers`.
+You can pass overrides for any of these in `setup`.
+Please see `lua/minitab.lua` for details.
 
 Example:
-```
-require('minitab').setup{
-    title = function() return '' end,
-    modified = function() return '' end,
-    windowCount = function() return '' end,
-    separator = function() return '' end,
+```lua
+require("minitab").setup{
+    modifiedC = "*",
+    separator = function(index)
+        local sepC = "><"
+        if index == 0 then
+            sepC = "<"
+        elseif index == vim.fn.tabpagenr('$')
+            sepC = ">"
+        end
+        return '%#TabLine#' .. sepC
+    end,
 }
 ```
-- 
cgit v1.2.3