aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 087577e..878e5d9 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,13 @@
# luatab.nvim
+## Features
+* Just a lua rewrite of the tabline render function
+* No weird mixing buffers and tabs stuff
+
+## Install
+Using packer.nvim:
+```
+use { 'alvarosevilla95/luatab.nvim', requires='kyazdani42/nvim-web-devicons' }
+```
## Usage
Add this to your init.lua:
@@ -8,8 +17,9 @@ Tabline = require'tabline'.tabline
vim.cmd[[ set tabline=%!luaeval('Tabline()') ]]
```
-Note: `require'tabline'.tabline` must be assigned to a global variable for it to be picked up by `luaeval`
+Note: `require'tabline'.tabline` must be assigned to a global variable for it to be picked up by `luaeval`. If you know a better method, PRs are welcome.
+## Configuration
You can also define your own tabline function using the provided functions for help. The default tabline is equivalent to:
```
local formatTab = require'luatab'.formatTab