diff --git a/README.md b/README.md index 55b1a44..fd8b5c0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Programmatic lua library for setting [base16](https://github.com/chriskempson/base16) themes in [Neovim](https://github.com/neovim/neovim). -(Note : This theme plugin is supposed to be used along with NvChad only so watchout!) +(Note: This theme plugin is supposed to be used along with [NvChad](https://github.com/NvChad/NvChad) only so watchout!) ## Usage @@ -22,8 +22,6 @@ local base16 = require 'base16' base16(base16.themes("brewer"), true) EOF ``` -(note : This colorscheme plugin keeps the guibg of NORMAL as none , so neovim just takes the terminal bg color , this is very useful when you want to have a transparent background ) - This is how I use it. Uses [`norcalli/nvim.lua`](https://github.com/norcalli/nvim.lua). @@ -35,13 +33,12 @@ base16(base16.themes[nvim.env.BASE16_THEME or "3024"], true) EOF ``` -You can define your own themes and use them with the `base16` function as long -as they match the format described below. I know the format is annoying to -define, so the `base16.theme_from_array` utility function is available. +You can define your own themes and use them with the `base16` function as long as they match the format described below. I know the format is annoying to define, so the `base16.theme_from_array` utility function is available. ## API ### base16.apply_theme(theme_definition: dict, use_256_colorspace: bool) + ### base16(theme_definition: dict, use_256_colorspace: bool) Alias for `base16.apply_theme(theme_definition: dict, use_256_colorspace: bool)`. @@ -54,8 +51,7 @@ base16(base16.themes("brewer"), true) ### base16.theme_from_array(theme_definition: array) -> dict -Formats an array of 16 hex color strings into a dictionary suitable for use -with `base16.apply_theme`. +Formats an array of 16 hex color strings into a dictionary suitable for use with `base16.apply_theme`. Example: @@ -88,10 +84,7 @@ base16.themes["zenburn"] == { ## Notes -Because this includes a copy of -[`norcalli/nvim.lua`](https://github.com/norcalli/nvim.lua), you should put -this after `norcalli/nvim.lua` in the plugin list because lua module resolution -is first-come-first-served, i.e. +Because this includes a copy of [`norcalli/nvim.lua`](https://github.com/norcalli/nvim.lua), you should put this after `norcalli/nvim.lua` in the plugin list because lua module resolution is first-come-first-served, i.e. ```vim Plug "norcalli/nvim.lua"