[READ-ONLY] Mirror of https://github.com/probablykasper/colorboy-js. Easy terminal coloring for Node.js, macOS/Linux
npmjs.com/package/colorboy
ansi
cli
color
package
terminal
README update
+9
-9
+9
-9
README.md
+9
-9
README.md
···
4
4
## Installation
5
5
`npm install colorboy`
6
6
7
-
## Usage:
7
+
## Usage
8
+
#### Usage example
8
9
```js
9
10
require("colorboy")();
10
11
console.log("this is colored".bright.underline.cyan);
11
12
```
12
13
Result:
13
-
*TBA*
14
+
15
+
14
16
15
17
16
-
require("colorboy")(ignoreDefaults, customColors);`
18
+
#### require("colorboy")(ignoreDefaults, customColors)
19
+
When you initiate colorboy, you can pass two arguments to it:
17
20
- ignoreDefaults: Optional. Defaults to `false`. Set it to true to disable all the default colors.
18
21
- customColors: Optional. Lets you add custom colors. See the example below.
22
+
23
+
19
24
```js
20
25
require("colorboy")(true, [
21
26
["crazy", "\x1b[4m\x1b[35m\x1b[1m"],
···
24
29
console.log("color".crazy,"boy".crazy);
25
30
```
26
31
Result:
27
-
*TBA*
28
-
29
32
30
-
### require("colorboy")(ignoreDefaults, customColors)
31
-
When you initiate colorboy, you can pass two optional arguments to it:
32
-
- ignoreDefaults:
33
-
- customColors:
33
+
34
34
35
35
## Colors & styles
36
36