aboutsummaryrefslogtreecommitdiff
path: root/node_modules/log-symbols/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/log-symbols/readme.md')
-rw-r--r--node_modules/log-symbols/readme.md51
1 files changed, 51 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..11dfccf
--- /dev/null
+++ b/node_modules/log-symbols/readme.md
@@ -0,0 +1,51 @@
+# log-symbols
+
+<img src="screenshot.png" width="226" height="192" 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
+
+```sh
+npm install log-symbols
+```
+
+## Usage
+
+```js
+import logSymbols from 'log-symbols';
+
+console.log(logSymbols.success, 'Finished successfully!');
+// Terminals with Unicode support: ✔ Finished successfully!
+// Terminals without Unicode support: √ 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
+- [log-symbols](https://github.com/palash25/log-symbols) - Ruby port
+- [guumaster/logsymbols](https://github.com/guumaster/logsymbols) - Golang port
+
+---
+
+<div align="center">
+ <b>
+ <a href="https://tidelift.com/subscription/pkg/npm-log-symbols?utm_source=npm-log-symbols&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+ </b>
+ <br>
+ <sub>
+ Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+ </sub>
+</div>