~fnux/telegram-tl-elixir

f8f30a16e8e43b2167b613c824ec7def6fd8190e — Timothée Floure 4 years ago 06956bc
Use the README as documentation's landpage
3 files changed, 18 insertions(+), 7 deletions(-)

M README.md
M lib/tl.ex
M mix.exs
M README.md => README.md +16 -2
@@ 5,5 5,19 @@ This library allows you to serialize and deserialize elements of the
designed to be used by
[telegram-mt-elixir](https://github.com/Fnux/telegram-mt-elixir).

The package is [on hex.pm](https://hex.pm/packages/telegram_tl) and the
documentation is available [here](https://hexdocs.pm/telegram_tl/TL.html).
The package and its documentation are on
[hex.pm](https://hex.pm/packages/telegram_tl).

## Configuration

If no configuration is specified, the
[API layer 23](https://core.telegram.org/schema?layer=23) will be used.
Although this library was only tested with the above layer version, you can
specify a custom source in you `config.exs` :

```
config :telegram_tl, tl_path: "/path/to/mtproto.json",
                     api_version: 23,
                     api_path: "/path/to/api-layer-23.json"

```

M lib/tl.ex => lib/tl.ex +1 -4
@@ 1,9 1,6 @@
defmodule TL do
  @moduledoc """
  This library allows you to serialize and deserialize elements of the
  [TL Language](https://core.telegram.org/mtproto/TL). It was originally
  designed to be used with
  [telegram-mt-elixir](https://github.com/Fnux/telegram-mt-elixir).
  Telegram TL : base module.
  """

  @doc """

M mix.exs => mix.exs +1 -1
@@ 15,7 15,7 @@ defmodule TL.Mixfile do
     name: "Telegram TL",
     source_url: "https://github.com/fnux/telegram-tl-elixir",
     homepage_url: "http://github.com/fnux/telegram-tl-elixir",
     docs: [main: "TL"]]
     docs: [main: "readme", extras: ["README.md"]]]
  end

  # Type "mix help compile.app" for more information