README.md

# UserAgentParser

**TODO: Add description**

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:

  1. Add user_agent_parser to your list of dependencies in `mix.exs`:

        def deps do
          [{:user_agent_parser, "~> 0.0.1"}]
        end

  2. Ensure user_agent_parser is started before your application:

        def application do
          [applications: [:user_agent_parser]]
        end


## Usage example

        iex(1)> user_agent = "Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; Microsoft; Lumia 640 XL)"
        iex(2)> UA.Parser.detect_browser(user_agent)
        %UA.Browser{family: "IE Mobile", version: "10.0"}
        iex(2)> UA.Parser.detect_os(user_agent)
        %UA.OS{family: "Windows Phone", version: "8.0"}
        iex(3)> UA.Parser.detect_device(user_agent)
        %UA.Device{brand: "Microsoft", model: "Lumia 640 XL", name: "Microsoft Lumia 640 XL"}
        iex(4)> UA.Parser.parse(user_agent)
        {%UA.Browser{family: "IE Mobile", version: "10.0"},
         %UA.OS{family: "Windows Phone", version: "8.0"},
         %UA.Device{brand: "Microsoft", model: "Lumia 640 XL",
          name: "Microsoft Lumia 640 XL"}}