Skip to content

Commit ea2d8db

Browse files
waldyriousagnivade
authored andcommitted
README: add info about the themes (fix #133)
1 parent 9f74d9f commit ea2d8db

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
A `Node.js` based command-line client for [tldr](https://github.com/tldr-pages/tldr).
1111

1212
![tldr screenshot](screenshot.png)
13+
*tldr-node-client's output for the `tar` page, using a custom color theme*
1314

1415
## Installing
1516

@@ -43,9 +44,9 @@ As a contributor, you might also need the following commands:
4344

4445
## Configuration
4546

46-
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.
47+
You can configure the `tldr` client by adding a `.tldrrc` file in your HOME directory. You can copy the contents of the `config.json` file from the repo to get the basic structure to start with, and modify it to suit your needs.
4748

48-
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.
49+
The default color theme is the one named `"simple"`. You can change the theme by assigning a different value to the `"theme"` variable -- either to choose one of the pre-configured themes, or to a new theme that you have previously created in the `"themes"` section. Note the the colors and text effects you can choose are limited. Refer to the [chalk documentation](https://github.com/chalk/chalk#styles) for all options.
4950

5051
```json
5152
{

0 commit comments

Comments
 (0)