Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 836 Bytes

README.md

File metadata and controls

36 lines (27 loc) · 836 Bytes

Flagmojis

Downloads

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, the package can be installed by adding flagmojis to your list of dependencies in mix.exs:

def deps do
  [
    {:flagmojis, "~> 1.0.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/flagmojis.