EmojiDiffer
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/emoji_differ
. To experiment with that code, run bin/console
for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
Installation
Add this line to your application's Gemfile:
gem 'emoji_differ'
And then execute:
$ bundle
Or install it yourself as:
$ gem install emoji_differ
Usage
Either set SLACK_API_TOKEN
env variable or create a .slack_token
file in your home directory, then try the gem:
require 'emoji_differ'
# update file on disk with current emoji in your team
EmojiDiffer.save
Get current emoji as an EmojiDiffer::List
of EmojiDiffer::Emoji
instances, for programmatic use:
EmojiDiffer.current
Some time later ...
# returns an EmojiDiffer::List of EmojiDiffer::Emoji instances, for programmatic use
EmojiDiffer.new_emoji
# outputs new emoji since the last time .save_emoji was called, in :name: format for pasting into slack
EmojiDiffer.new_emoji.to_s
EmojiDiffer.clear
EmojiDiffer.save
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jaggederest/emoji_differ. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the EmojiDiffer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.