This repository has been archived on 2021-05-23. You can view files and clone it, but cannot push or open issues or pull requests.
simpledash/bulma/node_modules/log-symbols/readme.md

46 lines
961 B
Markdown
Raw Normal View History

# log-symbols [![Build Status](https://travis-ci.org/sindresorhus/log-symbols.svg?branch=master)](https://travis-ci.org/sindresorhus/log-symbols)
<img src="screenshot.png" width="226" align="right">
> Colored symbols for various log levels
Includes fallbacks for Windows CMD which only supports a [limited character set](https://en.wikipedia.org/wiki/Code_page_437).
## Install
```
$ npm install log-symbols
```
## Usage
```js
const logSymbols = require('log-symbols');
console.log(logSymbols.success, 'Finished successfully!');
// On good OSes: ✔ Finished successfully!
// On Windows: √ Finished successfully!
```
## API
### logSymbols
#### info
#### success
#### warning
#### error
## Related
- [figures](https://github.com/sindresorhus/figures) - Unicode symbols with Windows CMD fallbacks
- [py-log-symbols](https://github.com/ManrajGrover/py-log-symbols) - Python port
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)