Update documentation

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/r8/elixir-oembed.svg?branch=master)](https://travis-ci.org/r8/elixir-oembed)
 [![Deps Status](https://beta.hexfaktor.org/badge/all/github/r8/elixir-oembed.svg)](https://beta.hexfaktor.org/github/r8/elixir-oembed)
-[![Inline docs](http://inch-ci.org/github/r8/elixir-oembed.svg?branch=master&style=flat)](http://inch-ci.org/github/r8/elixir-oembed)
+[![Inline docs](https://inch-ci.org/github/r8/elixir-oembed.svg?branch=master&style=flat)](http://inch-ci.org/github/r8/elixir-oembed)
 [![Ebert](https://ebertapp.io/github/r8/elixir-oembed.svg)](https://ebertapp.io/github/r8/elixir-oembed)
 [![Hex.pm](https://img.shields.io/hexpm/v/oembed.svg?style=flat-square)](https://hex.pm/packages/oembed)
 [![Hex.pm](https://img.shields.io/hexpm/dt/oembed.svg?style=flat-square)](https://hex.pm/packages/oembed)

lib/oembed.ex

@@ -1,40 +1,6 @@
 defmodule OEmbed do
   @moduledoc """
   oEmbed consumer library for Elixir applications.
-
-  > oEmbed is a format for allowing an embedded representation of a URL on third party sites. The simple API allows a website to display embedded content (such as photos or videos) when a user posts a link to that resource, without having to parse the resource directly.
-  >
-  > -- See [oembed.com](http://oembed.com) for more info about the protocol.
-
-  This library supports any discoverable oEmbed endpoint and some other services via custom adapters.
-  Among them:
-
-    - Instagram
-    - Pinterest
-
-  ## Installation
-
-  Add `oembed` to your list of dependencies in `mix.exs`:
-
-  ```elixir
-  def deps do
-    [{:oembed, "~> 0.2.0"}]
-  end
-  ```
-
-  ## Usage
-
-  ```elixir
-  {:ok, result} = OEmbed.for("https://www.youtube.com/watch?v=dQw4w9WgXcQ")
-  ```
-
-  ## Custom providers
-
-  You can implement modules that support provider behaviour and add them to the provider list from your app config
-
-  ```elixir
-  config :oembed, :providers, [MyApp.OEmbed.SomeProvider, MyApp.OEmbed.SomeOtherProvider]
-  ```
   """
 
   @core_providers [

mix.exs

@@ -11,7 +11,9 @@ defmodule OEmbed.Mixfile do
      start_permanent: Mix.env == :prod,
      description: description(),
      package: package(),
-     docs: docs(),
+     docs: [source_ref: @version,
+            main: "readme",
+            extras: ["README.md"]],
      deps: deps()]
   end