diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..37f2614 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,4 @@ +github: ionicabizau +patreon: ionicabizau +open_collective: ionicabizau +custom: https://www.buymeacoffee.com/h96wwchmy \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5173dd7..4884c52 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,66 +1,36 @@ -# :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles: :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk: +# ๐ŸŒŸ Contributing -So, you want to contribute to this project! That's awesome. However, before -doing so, please read the following simple steps how to contribute. This will -make the life easier and will avoid wasting time on things which are not -requested. :sparkles: +Want to contribute to this project? Great! Please read these quick steps to streamline the process and avoid unnecessary tasks. โœจ -## Discuss the changes before doing them - - First of all, open an issue in the repository, using the [bug tracker][1], - describing the contribution you would like to make, the bug you found or any - other ideas you have. This will help us to get you started on the right - foot. +## ๐Ÿ’ฌ Discuss Changes +Start by opening an issue in the repository using the [bug tracker][1]. Describe your proposed contribution or the bug you've found. If relevant, include platform info and screenshots. ๐Ÿ–ผ๏ธ - - If it makes sense, add the platform and software information (e.g. operating - system, Node.JS version etc.), screenshots (so we can see what you are - seeing). +Wait for feedback before proceeding unless the fix is straightforward, like a typo. ๐Ÿ“ - - It is recommended to wait for feedback before continuing to next steps. - However, if the issue is clear (e.g. a typo) and the fix is simple, you can - continue and fix it. +## ๐Ÿ”ง Fixing Issues -## Fixing issues - - Fork the project in your account and create a branch with your fix: - `some-great-feature` or `some-issue-fix`. +Fork the project and create a branch for your fix, naming it `some-great-feature` or `some-issue-fix`. Commit changes while following the [code style][2]. If the project has tests, add one. โœ… - - Commit your changes in that branch, writing the code following the - [code style][2]. If the project contains tests (generally, the `test` - directory), you are encouraged to add a test as well. :memo: +If a `package.json` or `bower.json` exists, add yourself to the `contributors` array; create it if it doesn't. ๐Ÿ™Œ - - If the project contains a `package.json` or a `bower.json` file add yourself - in the `contributors` array (or `authors` in the case of `bower.json`; - if the array does not exist, create it): +```json +{ + "contributors": [ + "Your Name (http://your.website)" + ] +} +``` - ```json - { - "contributors": [ - "Your Name (http://your.website)" - ] - } - ``` +## ๐Ÿ“ฌ Creating a Pull Request +Open a pull request and reference the initial issue (e.g., *fixes #*). Provide a clear title and consider adding visual aids for clarity. ๐Ÿ“Š -## Creating a pull request +## โณ Wait for Feedback +Your contributions will be reviewed. If feedback is given, update your branch as needed, and the pull request will auto-update. ๐Ÿ”„ - - Open a pull request, and reference the initial issue in the pull request - message (e.g. *fixes #*). Write a good description and - title, so everybody will know what is fixed/improved. +## ๐ŸŽ‰ Everyone Is Happy! +Your contributions will be merged, and everyone will appreciate your effort! ๐Ÿ˜„โค๏ธ - - If it makes sense, add screenshots, gifs etc., so it is easier to see what - is going on. +Thanks! ๐Ÿคฉ -## Wait for feedback -Before accepting your contributions, we will review them. You may get feedback -about what should be fixed in your modified code. If so, just keep committing -in your branch and the pull request will be updated automatically. - -## Everyone is happy! -Finally, your contributions will be merged, and everyone will be happy! :smile: -Contributions are more than welcome! - -Thanks! :sweat_smile: - - - -[1]: https://github.com/IonicaBizau/emojic/issues - -[2]: https://github.com/IonicaBizau/code-style +[1]: /issues +[2]: https://github.com/IonicaBizau/code-style \ No newline at end of file diff --git a/LICENSE b/LICENSE index f860972..ee32d24 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2015-22 Ionicฤƒ Bizฤƒu (https://ionicabizau.net) +Copyright (c) 2015-25 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 98cf63c..23b928d 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ # 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) + [![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 @@ -113,6 +113,7 @@ console.log(" " + colorIt(emojic.thumbsDown).green() + " " + colorIt("Thumbs dow + ## :question: Get Help There are few ways to get help: @@ -127,6 +128,8 @@ There are few ways to get help: + + ## :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. @@ -186,49 +189,54 @@ Thanks to [**@muan**](https://github.com/muan) for creating the [`emojilib`](htt ## :dizzy: Where is this library used? If you are using this library in one of your projects, add it in this list. :sparkles: + - `@adeeba123/adventure-game` + - `@bou-company/json2ts` + - `@codhek/cf-cli` + - `@epsidev/dionisio-cli` + - `@kushki/kushki-cli` + - `@lightjs/cli` + - `@sabroso/cli` + - `@viewar/cli` + - `@vtex/toolbelt-message-renderer` + - `@websser-tech/cli` + - `@wymaze/cm_common_library` + - `advent-of-code-client` + - `badou` + - `clipix` + - `colourpalettegenerator` + - `commandline-tool-shlomi-01` + - `community-hubbub` - `contentful-cli` + - `create-one-app` + - `cryptotracker` + - `dhxer-cli` + - `dhxer.sl-cli` + - `dkaframework` + - `dumb-client` + - `dynamic-model-generator` + - `dynogen` - `emoji-logger` - - `@vtex/toolbelt-message-renderer` - - `@lightjs/cli` - - `xrpcli` - `gsv` - - `mp3-stamp` - - `dhxer.sl-cli` - - `scrapy-chan` - - `cryptotracker` - - `clipix` + - `harvest-cli` + - `hubbub_community` + - `inquirer-level-select` + - `lazybee-cli` + - `light-test-netlify` - `light-testing-serverless-temp` - - `react-library-generator` - - `badou` - `mon-service` + - `mp3-stamp` - `node-charcoal` - - `xrpmon` - - `dynogen` - - `light-test-netlify` - - `@epsidev/dionisio-cli` - - `dumb-client` - - `hubbub_community` - - `@codhek/cf-cli` - - `tailwind-storybook` - - `@kushki/kushki-cli` - - `commandline-tool-shlomi-01` - - `advent-of-code-client` - - `viewar-cli` - - `react-native-gem` - - `lazybee-cli` - - `@andresmorelos/sam` - - `voila-cmd` - - `dhxer-cli` - - `omneedia` + - `node-modules-browser` - `ntbk` - - `harvest-cli` - - `community-hubbub` - - `dkaframework` + - `omneedia` - `push-to-start` - - `@wymaze/cm_common_library` - - `inquirer-level-select` - - `create-one-app` - - `@viewar/cli` + - `react-library-generator` + - `scrapy-chan` + - `utransfer-cli-demo` + - `viewar-cli` + - `voila-cmd` + - `xrpcli` + - `xrpmon` diff --git a/package.json b/package.json index 9df529d..e2afb44 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "emojic", - "version": "1.1.17", + "version": "1.1.18", "description": "Emoji in your Node.js command line apps.", "main": "lib/index.js", "directories": { @@ -55,6 +55,8 @@ "menu/", "cli.js", "index.js", + "index.d.ts", + "package-lock.json", "bloggify.js", "bloggify.json", "bloggify/"