emojione/lib/emojione-awesome/README.md

EmojiOne is a complete set of emojis designed for the web. It includes libraries to easily convert unicode characters to shortnames (:smile:) and shortnames to our custom emoji images. PNG formats provided for the emoji images.

# Emojione Awesome


### How to use

In the same vein as Font-Awesome, Emojione Awesome is for front end developers who just wanna drop an emoji on a page without using any sorts of scripts.
Uses human-friendly class names (based on emoji shortcodes). View a full list of shortcodes at www.emoji.codes


```
<!-- Coffee Emoji -->
<i class="e1a-coffee"></i>
```

Additional classes let you modify size:

```
<!-- Coffee Emoji (small) -->
<i class="e1a-coffee e1a-sm"></i>

<!-- Coffee Emoji (medium) -->
<i class="e1a-coffee e1a-med"></i>

<!-- Coffee Emoji (large) -->
<i class="e1a-coffee e1a-lg"></i>

```


# Thanks

Special Thanks to Michael Hartmann for creating these scripts for us!


### How to generate mapping

```
cd lib/emojione-awesome
node generate.js

```

### How to compile scss

Once you've generated the mapping you can build the css files via grunt.
The compiled styles are output into /extras/css/emojione-awesome.css

```
npm install grunt grunt-contrib-sass
grunt sass
```