# Telegramex

<!-- MDOC !-->

Telegram's Bot API wrapper.

[![Hex.pm Version](http://img.shields.io/hexpm/v/telegramex.svg?style=flat)](https://hex.pm/packages/telegramex)
[![CI](https://github.com/thiamsantos/telegramex/workflows/CI/badge.svg?branch=main)](https://github.com/thiamsantos/telegramex/actions?query=branch%3Amain)
[![Coverage Status](https://coveralls.io/repos/github/thiamsantos/telegramex/badge.svg?branch=main)](https://coveralls.io/github/thiamsantos/telegramex?branch=main)

## Features

- Support for multiple bots
- Configurable HTTP client
- No application configuration

## Usage

1. Add the dependencies

```elixir
def deps do
  [
    {:finch, "~> 0.5"},
    {:telegramex, "~> 0.1.0"}
  ]
end
```
2. Add the [finch](https://github.com/keathley/finch) client to your supervision tree

```elixir
children = [
  {Finch, name: Telegramex.HTTPClient}
]
```

**Note**: Checkout the `Telegramex.Client` on how to use other HTTP client.

3. Make a request

```elixir
client = %Telegramex.Client{token: "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"}
Telegramex.get_updates(client)
```

Full documentation can be found at [https://hexdocs.pm/telegramex](https://hexdocs.pm/telegramex).

## Changelog

See the [changelog](CHANGELOG.md).

<!-- MDOC !-->

## Code of Conduct

See the [code of conduct file](CODE_OF_CONDUCT.md).

## Contributing

See the [contributing file](CONTRIBUTING.md).

## License

[Apache License, Version 2.0](LICENSE) © [Thiago Santos](https://github.com/thiamsantos)