https://github.com/chrisgreg/flagmojis
An Elixir micro library that provides an easy lookup to country emoji flag information including ISO, Unicode, Emoji and Name.
https://github.com/chrisgreg/flagmojis
elixir emoji phoenix-framework
Last synced: 9 months ago
JSON representation
An Elixir micro library that provides an easy lookup to country emoji flag information including ISO, Unicode, Emoji and Name.
- Host: GitHub
- URL: https://github.com/chrisgreg/flagmojis
- Owner: chrisgreg
- License: mit
- Created: 2019-04-14T10:37:09.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-14T13:02:18.000Z (almost 7 years ago)
- Last Synced: 2024-03-14T21:20:13.061Z (almost 2 years ago)
- Topics: elixir, emoji, phoenix-framework
- Language: Elixir
- Homepage: https://hexdocs.pm/flagmojis/1.0.0/Flagmojis.html
- Size: 11.7 KB
- Stars: 18
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flagmojis

## What?
An Elixir micro library that provides an easy lookup to country emoji flag information including ISO, Unicode, Emoji and Name.
## Example
```
iex> Flagmojis.by_country_name("Cyprus")
%Flagmojis.Flag{
emoji: "🇨🇾",
iso: "CY",
name: "Cyprus",
unicode: "U+1F1E8 U+1F1FE"
}
```
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `flagmojis` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:flagmojis, "~> 1.0.0"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/flagmojis](https://hexdocs.pm/flagmojis).