diff options
Diffstat (limited to 'node_modules/chroma/README.md')
| -rw-r--r-- | node_modules/chroma/README.md | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/node_modules/chroma/README.md b/node_modules/chroma/README.md new file mode 100644 index 0000000..711c006 --- /dev/null +++ b/node_modules/chroma/README.md @@ -0,0 +1,76 @@ +#Chroma - Simple terminal colors for Node.js +##Contents + +1. [Install](#install) +2. [Introduction](#introduction) +3. [API](#api) + * [chroma \[color\]()](#chroma-color) + * [chroma()](#chroma) +5. [License](#license) + + +<br /> + +##Install + +`````text +npm install kagami +````` + +<br /> +##Introduction + +Chroma is a quick and easy way to print colors in Node.js terminal applications. +`````javascript +console.log('My favorite colors are ' + chroma.blue('blue') + ' and ' + chroma.white('white') + '!'); + +//My favorite colors are blue and white! +````` + +Chroma supports the following ASCII colors: + ++ Black ++ Red ++ Green ++ Yellow ++ Blue ++ Magenta ++ Cyan ++ White + +<br /> +##API + +<br /> +###chroma \[color\]() +Returns the given text wrapped in the correct ASCII color. + +Usage: +> **chroma \[color\]( text )** + +`````javascript +console.log(chroma.blue('This will be blue!')); +````` + +<br /> +###chroma() +Returns a generator function that can be used to produce the ASCII color that is closest to the supplied value. Accepts Hex and RGB values! + +Usage: +> **chroma ( hex string )** +> ** chroma ( red value, green value, blue value )** + +`````javascript +var blueifier = chroma('#00FFFF'); +var redifier = chroma(255, 12, 5); + +console.log(blueifier('This will be blue!')); +console.log(redifier('This will probably be red!')); +````` + +<br /> +##License + +Chroma is MIT licensed. You can read the license [here](https://raw.github.com/pachet/chroma/master/license). + + |