summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGustaf Rydholm <gustaf.rydholm@gmail.com>2022-07-29 17:58:39 +0200
committerGustaf Rydholm <gustaf.rydholm@gmail.com>2022-07-29 17:58:39 +0200
commite8d9b78648260cff45eb83266b1043a708c98d63 (patch)
tree624972d9bd74f83800768e3e4fe16d75eaa88d60
parent1aa942597ae9ff5e174821be01e3f45fa93c79f6 (diff)
Update readme
-rw-r--r--README.md37
1 files changed, 18 insertions, 19 deletions
diff --git a/README.md b/README.md
index 24853b6..c670c02 100644
--- a/README.md
+++ b/README.md
@@ -4,28 +4,9 @@ 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?)
-## Supported Plugins
-
-- Alpha
-- Git
-- Hop
-- Lir
-- LSP
-- Lualine
-- Markdown
-- Neogit
-- NvimCmp
-- NvimTree
-- Telescope
-- Treesitter
-- StatusLine (the default non custom one)
-- WhichKey
-
## Setup
The default configuration is:
-
```lua
-
{
transparent_background = palette.bg,
comments = "NONE",
@@ -35,8 +16,26 @@ The default configuration is:
type = "NONE",
}
```
+
These can be overridden when activating the plugin, e.g.:
```lua
require "no-clown-fiesta".setup({ type = "bold,italic" })
```
+
+## Supported Plugins
+
+- Alpha
+- Git
+- Hop
+- Lir
+- LSP
+- Lualine
+- Markdown
+- Neogit
+- NvimCmp
+- NvimTree
+- Telescope
+- Treesitter
+- StatusLine (the default non custom one)
+- WhichKey