add description

.gitignore

@@ -1,5 +1,6 @@
 /_build
 /cover
 /deps
+/doc
 erl_crash.dump
 *.ez

README.md

@@ -1,6 +1,15 @@
 # Ipgeobase
 
-**TODO: Add description**
+***Find Russian and Ukraine city by IP address. Source http://ipgeobase.ru/***
+
+  ## Examples
+
+      iex> ip = Ipgeobase.find_by_ip("46.188.121.160")
+      %Ipgeobase{city: "Москва", country: "RU"}
+      iex> ip.city
+      "Москва"
+      iex> ip.country
+      "RU"
 
 ## Installation
 

lib/ipgeobase.ex

@@ -4,6 +4,23 @@ defmodule Ipgeobase do
 
   def host, do: @initial_state
 
+  @moduledoc false
+
+  @doc ~S"""
+
+  Find Russian and Ukraine city by IP address. Source http://ipgeobase.ru/
+
+  ## Examples
+
+      iex> ip = Ipgeobase.find_by_ip("46.188.121.160")
+      %Ipgeobase{city: "Москва", country: "RU"}
+      iex> ip.city
+      "Москва"
+      iex> ip.country
+      "RU"
+
+  """
+
   def find_by_ip(ip) do
     query = URI.encode_query(%{ip: ip})
     uri_query = URI.to_string(URI.parse(host <> query))

mix.exs

@@ -8,6 +8,7 @@ defmodule Ipgeobase.Mixfile do
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
      description: description,
+     package: package,
      deps: deps]
   end
 
@@ -16,6 +17,16 @@ defmodule Ipgeobase.Mixfile do
     Find Russian and Ukraine city by IP address. Source http://ipgeobase.ru/
     """
   end
+
+  defp package do
+    [
+     files: ["lib", "mix.exs", "README.md"],
+     maintainers: ["Sergey Chechaev"],
+     licenses: ["MIT"],
+     links: %{"GitHub" => "https://github.com/sergey-chechaev/elixir_ipgeobase",
+              "Docs" => "https://hexdocs.pm/ipgeobase/0.0.1"}
+     ]
+  end
   # Configuration for the OTP application
   #
   # Type "mix help compile.app" for more information
@@ -36,7 +47,8 @@ defmodule Ipgeobase.Mixfile do
     [
       {:httpotion, "~> 2.2.0"},
       {:floki, "~> 0.8"},
-      {:iconv, "~> 1.0"}
+      {:iconv, "~> 1.0"},
+      {:ex_doc, "~> 0.11", only: :dev},
     ]
   end
 end

mix.lock

@@ -1,4 +1,5 @@
-%{"floki": {:hex, :floki, "0.8.0"},
+%{"ex_doc": {:hex, :ex_doc, "0.11.5"},
+  "floki": {:hex, :floki, "0.8.0"},
   "httpotion": {:hex, :httpotion, "2.2.2"},
   "ibrowse": {:hex, :ibrowse, "4.2.2"},
   "iconv": {:hex, :iconv, "1.0.0"},