consolecolor/docs/index.md

42 lines
2.3 KiB
Markdown
Raw Normal View History

2017-01-21 14:49:00 +00:00
# beautycolor
colors for beautylog
## Availabililty
2017-02-05 20:00:25 +00:00
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/beautycolor)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/beautycolor)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/beautycolor)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/beautycolor/)
2017-01-21 14:49:00 +00:00
## Status for master
[![build status](https://GitLab.com/pushrocks/beautycolor/badges/master/build.svg)](https://GitLab.com/pushrocks/beautycolor/commits/master)
[![coverage report](https://GitLab.com/pushrocks/beautycolor/badges/master/coverage.svg)](https://GitLab.com/pushrocks/beautycolor/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/beautycolor.svg)](https://www.npmjs.com/package/beautycolor)
[![Dependency Status](https://david-dm.org/pushrocks/beautycolor.svg)](https://david-dm.org/pushrocks/beautycolor)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/beautycolor/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/beautycolor/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/beautycolor/badges/code.svg)](https://www.bithound.io/github/pushrocks/beautycolor)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## Usage
Use TypeScript for best in class instellisense.
2017-01-21 17:13:44 +00:00
```javascript
import * as beautycolor from 'beautycolor'
let myColoredString = beautycolor.coloredString(
'This string has a blue font and a green background',
'blue',
'green'
)
console.log(myColoredString)
```
2017-08-16 08:42:48 +00:00
For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)