Skip to content

Commit ffe5b68

Browse files
committed
Update README to reflect theme changes
1 parent 05b14b0 commit ffe5b68

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,29 @@ As a contributor, you might also need the following commands:
5151

5252
## Configuration
5353

54-
You can configure the `tldr` client by adding a `.tldrrc` file in your HOME directory.
55-
This file has to be valid JSON:
54+
You can configure the `tldr` client by adding a `.tldrrc` file in your HOME directory. Start by copying the `config.json` file from the repo.
55+
56+
You can choose any of the themes by changing the `"theme"` variable, or you can create your own theme and add it to the `"themes"` section. Note the the colors and text effects you can choose are limited. Refer [here](https://github.com/chalk/chalk#styles) for all options.
5657

5758
```json
5859
{
59-
"colors": {
60-
"text": "green",
61-
"command-background": "black",
62-
"command-foreground": "red",
63-
"command-token": "white"
64-
}
60+
"themes": {
61+
"ocean": {
62+
"commandName": "bold, cyan",
63+
"mainDescription": "",
64+
"exampleDescription": "green",
65+
"exampleCode": "cyan",
66+
"exampleToken": "dim"
67+
},
68+
"myOwnCoolTheme": {
69+
"commandName": "bold, red",
70+
"mainDescription": "underline",
71+
"exampleDescription": "yellow",
72+
"exampleCode": "underline, green",
73+
"exampleToken": ""
74+
}
75+
},
76+
"theme": "ocean"
6577
}
6678
```
6779

0 commit comments

Comments
 (0)