summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGustaf Rydholm <gustaf.rydholm@gmail.com>2022-07-29 17:46:25 +0200
committerGustaf Rydholm <gustaf.rydholm@gmail.com>2022-07-29 17:46:25 +0200
commit6a9875212b00db7c65d7af9b664bd4ef57050771 (patch)
tree5731a5f2c934fe2da5b79aef24f708590af67ae0
parent731125cac35578b4a3bbedc6ee8a25b4ad05a9d3 (diff)
Update readmebeta
-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" })
+```