aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTim Keller <tjkeller.xyz>2024-11-28 12:01:57 -0600
committerTim Keller <tjkeller.xyz>2024-11-28 12:01:57 -0600
commitf6183e8cb6f408e54dd5d1d13c0075376655a3ec (patch)
tree4793b9ed6394e24f8002f3b02540315d86b0e898 /README.md
parent53921c4f2b2ef868b1bed70bc11ab330b0ad4a47 (diff)
downloadminitab.nvim-f6183e8cb6f408e54dd5d1d13c0075376655a3ec.tar.xz
minitab.nvim-f6183e8cb6f408e54dd5d1d13c0075376655a3ec.zip
fix some readme errorsHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index fdf4c96..c6bd2fe 100644
--- a/README.md
+++ b/README.md
@@ -8,16 +8,18 @@ Minitab started as a fork of
[`alvarosevilla95/luatab.nvim`](https://github.com/alvarosevilla95/luatab.nvim)
## Features
-* Text only rendering
-* Size/position of tabs doesn't change while switching between them
-* File paths are not shown
+* Hackable text-only rendering
+* Size/position of tabs doesn't change while switching tabs
+* Minimal file paths are 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 `
+` +2 README.md | minitab/init.lua | + [No Name] | ~/docs/src/ | newrw | zsh | TelescopePrompt | help:builtin `
-The above text demonstrates or less what you can expect from this plugin's
+The above text demonstrates more or less what to expect from this plugin's
default tabline rendering.
+This example also shows how several special cases for various buffer types are
+handled.
## Install
Using a [`lazy.nvim`](https://github.com/folke/lazy.nvim) module
@@ -29,7 +31,7 @@ return { url = 'https://git.tjkeller.xyz/minitab.nvim', config = true }
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.
+See `lua/minitab.lua` for details.
Example:
```lua