Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
medikoo committed Jul 11, 2011
1 parent e5f8913 commit d7c3ed1
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
@@ -1,6 +1,7 @@
# cli-color - Yet another color package for console output.
# cli-color - Yet another console color package.

What's wrong with the others ? Awesome ones mess with built-ins, less awesome seem too verbose in use. This one aims to be both safe and neat.
What's wrong with the others ?
Awesome ones mess with built-ins, less awesome seem too verbose in use. This one aims to be both safe and neat.

## Installation

Expand All @@ -20,6 +21,10 @@ Styles can be mixed:

color.log(ccolor.red.bgWhite.underline('Underlined red text on white background.'));

Styled text can be mixed with unstyled:

ccolor.log(ccolor.red('red') + ' plain ' + ccolor.blue('blue'));

Best way is to preset needed stylings and then use it:

var error = ccolor.red.bold;
Expand All @@ -30,6 +35,7 @@ Best way is to preset needed stylings and then use it:
console.log(warn('Warning'));
console.log(notice('Notice'));


Supported are all ANSI colors and styles:

### Styles
Expand Down

0 comments on commit d7c3ed1

Please sign in to comment.