1# emojis
2
3[![CI
4tests](https://github.com/jgm/emojis/workflows/CI%20tests/badge.svg)](https://github.com/jgm/emojis/actions)
5
6This package provides functions for looking up an emoji by its name
7(alias), and for returning the aliases of an emoji.
8
9A full list of (alias, emoji) pairs is also exported.
10
11Emoji data (`emoji.json`) is taken from the
12[`gemoji`](https://github.com/github/gemoji) gem, used by GitHub.  To
13regenerate the `emoji.json` datafile from the latest gemoji source, do `make
14emoji.json`.  If `emoji.json` has changed, do `make` to regenerate the
15`emojis.inc` file and rebuild the project.
16
17This package has the following advantages over the `emoji` package on Hackage:
18
19- It supports a fuller range of emojis, including all those supported by GitHub
20- It supports lookup of emoji aliases from emoji
21- It uses Text rather than String
22- It has a lighter dependency footprint: in particular, it does not require aeson
23- It does not require TemplateHaskell
24
25