diff options
Diffstat (limited to 'node_modules/log-symbols/readme.md')
| -rw-r--r-- | node_modules/log-symbols/readme.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/node_modules/log-symbols/readme.md b/node_modules/log-symbols/readme.md new file mode 100644 index 0000000..8459a57 --- /dev/null +++ b/node_modules/log-symbols/readme.md @@ -0,0 +1,45 @@ +# log-symbols [](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) |