From 04bd315ee1d16308db3095049fe7e1ba2ef9f726 Mon Sep 17 00:00:00 2001 From: Gustaf Rydholm Date: Sat, 29 Oct 2022 18:14:16 +0200 Subject: Update README --- README.md | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a8b03c5..dec0af9 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,34 @@ An attempt at a color scheme that does not look like a clown puked up the source ![image](https://gustafrydholm.xyz/images/no-clown-fiesta.png?) -## Setup -The default configuration is: +## Usage + +To enable this colorscheme: + +```vim +colorscheme no-clown-fiesta +``` + ```lua -{ - transparent_background = palette.bg, - comments = "NONE", - keywords = "NONE", - functions = "NONE", - variables = "NONE", - type = "NONE", -} +vim.cmd[[colorscheme no-clown-fiesta]] ``` -These can be overridden when activating the plugin, e.g.: +To override the default settings you need to call setup before enabling the +colorscheme. No-clown-fiesta will use these settings, unless you call setup +and override these. ```lua -require("no-clown-fiesta").setup({ type = "bold,italic" }) +require("no-clown-fiesta").setup({ + transparent = false, -- Enable this to disable the bg color + styles = { + -- You can set any of the style values specified for `:h nvim_set_hl` + comments = {}, + keywords = {}, + functions = {}, + variables = {}, + type = { bold = true }, + }, +}) ``` ## Supported Plugins -- cgit v1.2.3-70-g09d2