summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoraktersnurra <gustaf.rydholm@gmail.com>2022-07-29 17:51:29 +0200
committerGitHub <noreply@github.com>2022-07-29 17:51:29 +0200
commit85d7d7de20b6330528c5b7c0243c3afcc5266711 (patch)
tree5731a5f2c934fe2da5b79aef24f708590af67ae0 /README.md
parentda502c2571b710791b29c82a77cbe577791b14df (diff)
Update configuration api (#5)
* Refactor * Fix opts * Fix plugin typos * Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 15 insertions, 13 deletions
diff --git a/README.md b/README.md
index 2f7b2a5..24853b6 100644
--- a/README.md
+++ b/README.md
@@ -21,20 +21,22 @@ An attempt at a color scheme that does not look like a clown puked up the source
- StatusLine (the default non custom one)
- WhichKey
-## Configuration
-It's possible to configure some preferences, for example:
+## Setup
+The default configuration is:
```lua
-vim.g.transparent_background = true
-vim.g.italic_comments = false
+
+{
+ transparent_background = palette.bg,
+ comments = "NONE",
+ keywords = "NONE",
+ functions = "NONE",
+ variables = "NONE",
+ type = "NONE",
+}
```
+These can be overridden when activating the plugin, e.g.:
-These are all the available variables and their default values.
-| Variable | Default |
-| --- | --- |
-| transparent_background | false |
-| italic_comments | true |
-| italic_keywords | false |
-| italic_functions | false |
-| italic_variables | false |
-| bold_type | false |
+```lua
+require "no-clown-fiesta".setup({ type = "bold,italic" })
+```