diff --git a/.gitignore b/.gitignore index af96bda..2ca2591 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ node_modules *.env .DS_Store package-lock.json +.bloggify/* diff --git a/LICENSE b/LICENSE index d21973e..f43e830 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2015-19 Ionică Bizău (https://ionicabizau.net) +Copyright (c) 2015-20 Ionică Bizău (https://ionicabizau.net) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index fc39c6c..531ed69 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,58 @@ + + + + + + [![emojic](http://i.imgur.com/bflsgPt.png)](#) + + + + + + + + + + # emojic [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/emojic.svg)](https://www.npmjs.com/package/emojic) [![Downloads](https://img.shields.io/npm/dt/emojic.svg)](https://www.npmjs.com/package/emojic) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github) Buy Me A Coffee + + + + + + > Emoji in your Node.js command line apps. + + + + + In the screenshot below I'm using a Linux terminal emulator which doesn't support *colorful* emoji (in the way like OS X does). + + + + + [![emojic](http://i.imgur.com/o0DJDca.png)](#) + + + + + + ## :cloud: Installation ```sh @@ -26,6 +64,17 @@ yarn add emojic ``` + + + + + + + + + + + ## :clipboard: Example @@ -56,28 +105,49 @@ console.log(" " + colorIt(emojic.thumbsDown).green() + " " + colorIt("Thumbs dow + + + + + + + + ## :question: Get Help There are few ways to get help: + + 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question. 2. For bug reports and feature requests, open issues. :bug: - 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: + + ## :memo: Documentation Require the library using `var emojic = require("emojic")`. Then you can use the camel case notation for the emoji names (like in the example). Visit [emoji.muan.co](http://emoji.muan.co) to search the icons. For example, if you want to display in console `:heart_eyes:` (:heart_eyes:), you will use `console.log(emojic.heartEyes)` (notice the camelCaseStyle) + + + + + + + + + + + ## :yum: How to contribute Have an idea? Found a bug? See [how to contribute][contributing]. ## :sparkling_heart: Support my projects - I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it). @@ -96,43 +166,86 @@ However, if you get some profit from this or just want to encourage me to contin Thanks! :heart: + + + + + + + ## :cake: Thanks Thanks to [**@muan**](https://github.com/muan) for creating the [`emojilib`](https://github.com/muan/emojilib) project we use here. :sparkles: + + + + + + + ## :dizzy: Where is this library used? If you are using this library in one of your projects, add it in this list. :sparkles: + - `contentful-cli` + - `emoji-logger` + - `light` + - `@vtex/toolbelt-message-renderer` + - `ntbk` + - `node-charcoal` + - `scrapy-chan` + - `inquirer-level-select` + - `xrpmon` + - `cryptotracker` + - `lazybee-cli` + - `xrpcli` + - `@kushki/kushki-cli` + - `gsv` + - `omneedia` + - `mp3-stamp` + - `badou` + - `voila-cmd` + - `@codhek/cf-cli` + - `harvest-cli` + - `hubbub_community` + - `dumb-client` + - `community-hubbub` + - `light-testing-serverless-temp` + - `light-test-netlify` + - `@epsidev/dionisio-cli` + - `react-library-generator` + - `commandline-tool-shlomi-01` + - `mon-service` + - `viewar-cli` + - `react-native-gem` + - `@viewar/cli` + + + + + + + + + - - [`colourpalettegenerator`](https://npmjs.com/package/colourpalettegenerator) (by melaniebdev)—From a .less, .scss, .css file, create a visual colour palette from hexidecimal colours - - [`contentful-cli`](https://github.com/contentful/contentful-cli#readme) (by Contentful)—Contentful CLI tool - - [`cryptotracker`](https://github.com/christophior/xrpcli#readme) (by Chris Villarreal)—A cryptocurrency price monitoring tool for different cryptos - - [`emoji-logger`](https://github.com/IonicaBizau/emoji-logger#readme)—Logging library based on flat colors and Emoji. - - [`gsv`](https://github.com/gsv/cli) (by Garet McKinley @garetmckinley)—Opinionated gatsby starter with powerful cli tools - - [`inquirer-level-select`](https://npmjs.com/package/inquirer-level-select) (by gzlinguangyu)—a level data selector for Inquirer.js - - [`lazybee-cli`](https://npmjs.com/package/lazybee-cli) (by Koen Chen)—A command-line tool for install lazybee - - [`node-charcoal`](https://npmjs.com/package/node-charcoal) (by James Quinlan)—Shared JS/SCSS variables - - [`ntbk`](https://michaelsoolee.com/ntbk-journal/) (by Michael Lee)—A simple command-line journaling tool. - - [`omneedia`](https://github.com/omneedia/omneedia-cli#readme) (by Stephane Zucatti)—Omneedia CLI Framework - - [`react-library-generator`](https://npmjs.com/package/react-library-generator) (by Jalal azimi)—CLI for create react libraries - - [`scrapy-chan`](https://github.com/bitliner/scraps#readme)—Scraping made easy. - - [`xrpcli`](https://github.com/christophior/xrpcli#readme) (by Chris Villarreal)—A cryptocurrency price monitoring tool for XRP - - [`xrpmon`](https://github.com/christophior/xrpmon#readme) (by Chris Villarreal)—A cryptocurrency price monitoring tool for XRP ## :scroll: License [MIT][license] © [Ionică Bizău][website] + + + + +[license]: /LICENSE +[website]: https://ionicabizau.net +[contributing]: /CONTRIBUTING.md +[docs]: /DOCUMENTATION.md [badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg [badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg [badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg [badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg - [patreon]: https://www.patreon.com/ionicabizau [amazon]: http://amzn.eu/hRo9sIZ [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW - -[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit -[website]: https://ionicabizau.net -[contributing]: /CONTRIBUTING.md -[docs]: /DOCUMENTATION.md diff --git a/package.json b/package.json index a2c6874..b8ef829 100644 --- a/package.json +++ b/package.json @@ -59,4 +59,4 @@ "bloggify.json", "bloggify/" ] -} \ No newline at end of file +}