From 54d57b05067d40068ae3a9ccb681a135eff1aa1b Mon Sep 17 00:00:00 2001 From: Alvaro Sevilla Date: Mon, 5 Jul 2021 11:29:11 +0100 Subject: Update README --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3