7 7 ╚═════╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═╝ ╚══════╝ 8 8 ``` 9 9 10 -  10 +  11 11 12 12 13 - <p align="center"><img src="https://raw.githubusercontent.com/dominikwilkowski/cfonts/master /img/example2.png" alt="api example"></p> 13 + <p align="center"><img src="https://raw.githubusercontent.com/dominikwilkowski/cfonts/released /img/example2.png" alt="api example"></p> 14 14 <p align="center"><a href="https://nodei.co/npm/cfonts/"><img src="https://nodei.co/npm/cfonts.png?downloads=true" alt="npm status"></a></p> 15 15 <p align="center"> 16 - <a href="https://travis-ci.org/dominikwilkowski/cfonts"><img src="https://travis-ci.org/dominikwilkowski/cfonts.svg?branch=master " alt="build status"></a> 17 - <a href='https://coveralls.io/github/dominikwilkowski/cfonts?branch=master '><img src='https://coveralls.io/repos/github/dominikwilkowski/cfonts/badge.svg?branch=master ' alt='CFont Coverage Status' /></a> 16 + <a href="https://travis-ci.org/dominikwilkowski/cfonts"><img src="https://travis-ci.org/dominikwilkowski/cfonts.svg?branch=released " alt="build status"></a> 17 + <a href='https://coveralls.io/github/dominikwilkowski/cfonts?branch=released '><img src='https://coveralls.io/repos/github/dominikwilkowski/cfonts/badge.svg?branch=released ' alt='CFont Coverage Status' /></a> 18 18 </p> 19 19 20 20 <p align="center">This is a silly little command line tool for sexy fonts in the console. <strong>Give your cli some love.</strong></p> 123 123 $ cfonts --help 124 124 ``` 125 125 126 -  126 +  127 127 128 128 129 129 #### -V, --version 136 136 $ cfonts --version 137 137 ``` 138 138 139 -  139 +  140 140 141 141 142 142 #### text 150 150 $ cfonts "Hello world" 151 151 ``` 152 152 153 -  153 +  154 154 155 155 156 156 #### -f, --font 163 163 $ cfonts "text" --font "chrome" 164 164 ``` 165 165 166 -  166 +  167 167 168 168 - `block` [colors: 2] _(default)_ 169 -  169 +  170 170 - `slick` [colors: 2] 171 -  171 +  172 172 - `tiny` [colors: 1] 173 -  173 +  174 174 - `grid` [colors: 2] 175 -  175 +  176 176 - `pallet` [colors: 2] 177 -  177 +  178 178 - `shade` [colors: 2] 179 -  179 +  180 180 - `chrome` [colors: 3] 181 -  181 +  182 182 - `simple` [colors: 1] 183 -  183 +  184 184 - `simpleBlock` [colors: 1] 185 -  185 +  186 186 - `3d` [colors: 2] 187 -  187 +  188 188 - `simple3d` [colors: 1] 189 -  189 +  190 190 - `huge` [colors: 2] 191 -  191 +  192 192 - `console` [colors: 1] 193 -  193 +  194 194 195 195 196 196 #### -a, --align 207 207 $ cfonts "text" --align "center" 208 208 ``` 209 209 210 -  210 +  211 211 212 212 213 213 #### -c, --colors 244 244 $ cfonts "text" --colors white,"#f80" 245 245 ``` 246 246 247 -  247 +  248 248 249 249 250 250 #### -g, --gradient 276 276 $ cfonts "text" --gradient red,"#f80" 277 277 ``` 278 278 279 -  279 +  280 280 281 281 282 282 #### -i, --independent-gradient 290 290 $ cfonts "text|next line" --gradient red,"#f80" --independent-gradient 291 291 ``` 292 292 293 -  293 +  294 294 295 295 296 296 #### -t, --transition-gradient 306 306 $ cfonts "text" --gradient red,"#f80",green,blue --transition-gradient 307 307 ``` 308 308 309 -  309 +  310 310 311 311 312 312 #### -b, --background 338 338 $ cfonts "text" --background "Green" 339 339 ``` 340 340 341 -  341 +  342 342 343 343 344 344 #### -l, --letter-spacing 351 351 $ cfonts "text" --letter-spacing 2 352 352 ``` 353 353 354 -  354 +  355 355 356 356 357 357 #### -z, --line-height 364 364 $ cfonts "text" --line-height 2 365 365 ``` 366 366 367 -  367 +  368 368 369 369 370 370 #### -s, --spaceless 377 377 $ cfonts "text" --spaceless 378 378 ``` 379 379 380 -  380 +  381 381 382 382 383 383 #### -m, --max-length 392 392 $ cfonts "text" --max-length 15 393 393 ``` 394 394 395 -  395 +  396 396 397 397 398 398 #### -e, --env 425 425 ); 426 426 ``` 427 427 428 -  428 +  429 429 430 430 431 431 ## Consistency 455 455 456 456 457 457 ## Tests 458 - This package is tested on the below platform and node combinations as part of our [CI](https://github.com/dominikwilkowski/cfonts/tree/master /.travis.yml). 458 + This package is tested on the below platform and node combinations as part of our [CI](https://github.com/dominikwilkowski/cfonts/tree/released /.travis.yml). 459 459 460 460 | Platform | Node | 461 461 |----------|--------| 470 470 | Windows | latest | 471 471 472 472 ### Unit tests 473 - The package comes with a bunch of [unit tests](https://github.com/dominikwilkowski/cfonts/tree/master /test/unit) that aim to cover 100% of the code base. 474 - For more details about the code coverage check out [coveralls](https://coveralls.io/github/dominikwilkowski/cfonts?branch=master ). 473 + The package comes with a bunch of [unit tests](https://github.com/dominikwilkowski/cfonts/tree/released /test/unit) that aim to cover 100% of the code base. 474 + For more details about the code coverage check out [coveralls](https://coveralls.io/github/dominikwilkowski/cfonts?branch=released ). 475 475 476 476 ```shell 477 477 npm run test:unit 480 480 ### Type tests 481 481 Since the code base uses [JSDocs](https://jsdoc.app/) we use [typescript](https://www.typescriptlang.org/) to test the inferred types from those comments. 482 482 Typescript [supports JSDocs](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#supported-jsdoc) and we use it in our 483 - [test](https://github.com/dominikwilkowski/cfonts/blob/master /package.json#L38). 483 + [test](https://github.com/dominikwilkowski/cfonts/blob/released /package.json#L38). 484 484 485 485 ```shell 486 486 npm run test:types 487 487 ``` 488 488 489 489 ### Font file test 490 - There is also a [test suite](https://github.com/dominikwilkowski/cfonts/blob/master /test/fonttest.js) for font files. 490 + There is also a [test suite](https://github.com/dominikwilkowski/cfonts/blob/released /test/fonttest.js) for font files. 491 491 492 492 ```shell 493 493 npm run test:fonts 510 510 511 511 512 512 ## Release History 513 + * 2.8.5 - renamed branches 513 514 * 2.8.4 - fixed block double quote 514 515 * 2.8.3 - bumped dependencies 515 516 * 2.8.2 - bumped dependencies, added linting, fixed #22 (again) 566 567 567 568 568 569 ## License 569 - Copyright (c) 2018 Dominik Wilkowski. Licensed under the [GNU GPLv2](https://github.com/dominikwilkowski/cfonts/blob/master /LICENSE). 570 + Copyright (c) 2018 Dominik Wilkowski. Licensed under the [GNU GPLv2](https://github.com/dominikwilkowski/cfonts/blob/released /LICENSE). 570 571
Dominik Wilkowski
committed
4 years ago