aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 7 insertions, 14 deletions
diff --git a/README.md b/README.md
index e3376b9..fa82e49 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,35 @@
-# luatab.nvim
+# cleantab.nvim
-<p align="center">
- <img src="https://github.com/alvarosevilla95/luatab.nvim/blob/master/pics/tabline.png" />
-</p>
+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
## Install
-Using packer.nvim:
-```lua
-use { 'alvarosevilla95/luatab.nvim', requires='nvim-tree/nvim-web-devicons' }
-```
-
Using [`lazy.nvim`](https://github.com/folke/lazy.nvim)
```lua
-{ 'alvarosevilla95/luatab.nvim', dependencies = { 'nvim-tree/nvim-web-devicons' } }
+{ 'https://git.tjkeller.xyz/cleantab.nvim' }
```
## Usage
Add this to your init.lua:
```lua
-require('luatab').setup{}
+require('cleantab').setup{}
```
## 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/luatab/init.lua` for details.
+You can pass overrides for any of these functions in `setup`. Please see `lua/cleantab/init.lua` for details.
Example:
```
-require('luatab').setup{
+require('cleantab').setup{
title = function() return '' end,
modified = function() return '' end,
windowCount = function() return '' end,
- devicon = function() return '' end,
separator = function() return '' end,
}
```