readme tweaks

This commit is contained in:
Sindre Sorhus 2015-02-17 15:57:40 +07:00
parent 99614e760f
commit c799a8aaed
2 changed files with 11 additions and 8 deletions

View file

@ -1,7 +1,7 @@
{ {
"name": "chalk", "name": "chalk",
"version": "0.5.1", "version": "0.5.1",
"description": "Terminal string styling done right. Created because the `colors` module does some really horrible things.", "description": "Terminal string styling done right. Much color.",
"license": "MIT", "license": "MIT",
"repository": "sindresorhus/chalk", "repository": "sindresorhus/chalk",
"maintainers": [ "maintainers": [

View file

@ -20,13 +20,13 @@
- Clean and focused - Clean and focused
- Auto-detects color support - Auto-detects color support
- Actively maintained - Actively maintained
- [Used by 2200+ modules](https://www.npmjs.com/browse/depended/chalk) - [Used by ~3000 modules](https://www.npmjs.com/browse/depended/chalk)
## Install ## Install
```sh ```
npm install --save chalk $ npm install --save chalk
``` ```
@ -89,10 +89,13 @@ Multiple arguments will be separated by space.
### chalk.enabled ### chalk.enabled
Color support is automatically detected, but you can override it by setting the Color support is automatically detected, but you can override it by setting the `enabled` property. You should however only do this in your own code as it applies globally to all chalk consumers.
`enabled` property or by creating a new instance just for your usage. Changing
the property should only be done from end-user facing applications as it If you need to change this in a reusable module create a new instance:
affects all consumers of the default chalk instance
```js
var ctx = new chalk.constructor({enabled: false});
```
### chalk.supportsColor ### chalk.supportsColor