From 342686202dad747e11b152df305bede49d9dde86 Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Fri, 13 Dec 2013 20:21:51 +0100 Subject: [PATCH] Improve docs --- readme.md | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/readme.md b/readme.md index 35a2ec7..46813ac 100644 --- a/readme.md +++ b/readme.md @@ -1,10 +1,10 @@ # chalk -> Terminal string styling done right. +> Terminal string styling done right [![Build Status](https://secure.travis-ci.org/sindresorhus/chalk.png?branch=master)](http://travis-ci.org/sindresorhus/chalk) -[colors.js](https://github.com/Marak/colors.js) is currently the most popular string styling module, but it has serious deficiencies like extending String.prototype which causes all kinds of problems. Although there are other ones, they either do too much or not enough. +[colors.js](https://github.com/Marak/colors.js) is currently the most popular string styling module, but it has serious deficiencies like extending String.prototype which causes all kinds of [problems](https://github.com/yeoman/yo/issues/68). Although there are other ones, they either do too much or not enough. **Chalk is a clean and focused alternative.** @@ -18,6 +18,7 @@ - Clean and focused - Auto-detects color support - Actively maintained +- [Used by 150+ modules](https://npmjs.org/browse/depended/chalk) ## Install @@ -27,25 +28,25 @@ Install with [npm](https://npmjs.org/package/chalk): `npm install --save chalk` ## Example -Chalk comes with an easy to use composable API where you just chain the styles you want. +Chalk comes with an easy to use composable API where you just chain and nest the styles you want. ```js var chalk = require('chalk'); // style a string -console.log(chalk.blue('Hello world!')); +console.log( chalk.blue('Hello world!') ); // combine styled and normal strings -console.log(chalk.blue('Hello'), 'World' + chalk.red('!')); +console.log( chalk.blue('Hello'), 'World' + chalk.red('!') ); // compose multiple styles using the chainable API -console.log(chalk.blue.bgRed.bold('Hello world!')); +console.log( chalk.blue.bgRed.bold('Hello world!') ); // nest styles -chalk.red('Hello', chalk.underline.bgBlue('world') + '!'); +console.log( chalk.red('Hello', chalk.underline.bgBlue('world') + '!') ); // pass in multiple arguments -console.log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz')); +console.log( chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz') ); ``` You can easily define your own themes. @@ -61,9 +62,11 @@ console.log(error('Error!')); ### chalk.`