Commit 7dbea734 by Mark Wunsch

README

parent e7b6c0d9
# Rack::Emoji
# Rumoji
TODO: Write a gem description
This is a tool to convert Emoji UTF-8 into the codes used by http://www.emoji-cheat-sheet.com/ and back again.
## Installation
Why would you want to do this? Read this _forthcoming_ blog post: ...
Add this line to your application's Gemfile:
## tl;dr
gem 'rack-emoji'
>**Do not store emoji unicodes in your database. Store the human-friendly code and support the emoji-cheat-sheet.**
And then execute:
>By doing this, you can ensure that users across devices can see the author’s intention. You can always show users an image, but you can’t show them a range of characters their system does not support.
$ bundle
Or install it yourself as:
## Usage
$ gem install rack-emoji
Rumoji.encode(str)
# Takes a String, transforms Emoji into cheat-sheet codes
## Usage
Rumoji.decode(str)
# Does the reverse
TODO: Write usage instructions here
Thanks!
## Contributing
## Copyright
Copyright (c) 2009 - 2012 Mark Wunsch. Licensed under the MIT License.
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment