$ github-emojify

Emojify your GitHub repository descriptions.

:cloud: Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global github-emojify

# Using yarn
yarn global add github-emojify

Then, run github-emojify --help and see what the CLI tool can do.

$ github-emojify --help
Usage: github-emojify [options]

Options:
  -i, --input <owner[/repo]>  The GitHub username or repository full name
                              (owner/repo).
  -t, --token <token>         Your GitHub token. Generate one here:
                              https://github.com/settings/tokens/new
  -r, --remove                Remove first emoji from the description.
  -h, --help                  Displays this help.
  -v, --version               Displays version information.

Examples:
  # Emojify just one  repository description
  github-emojify -i ionicabizau/git-stats
  # Emojify all my repository descriptions
  github-emojify -i ionicabizau

Enjoy the emoji spirit!

Documentation can be found at https://github.com/IonicaBizau/github-emojify#readme

:crystal_ball: Before & After

:clipboard: Example

Here is an example how to use this package as library. To install it locally, as library, you can use npm install github-emojify (or yarn add github-emojify):

const githubEmojify = require("github-emojify");

// Emojify just one repo
githubEmojify("ionicabizau/git-stats", "your token");

// Emojify all my repos by this owner
githubEmojify("ionicabizau", "your token").on(
    "finish"
  , console.log
);

// Remove emoji from all my repository descriptions
githubEmojify("ionciabizau", "my token", true);

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. 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. :rocket:

:memo: Documentation

For full API reference, see the DOCUMENTATION.md file.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

: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).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău