![ferris](https://raw.githubusercontent.com/ferrisgram/logos/new-logo/textual-logo/ferrisgram-textual.png)
<p align="center">
    <br>
    <b>An Elegant Rust Client for Telegram Bot API</b>
    <br>
    <a href="https://crates.io/crates/ferrisgram">
        crates.io
    </a>
    •
    <a href="https://docs.rs/ferrisgram">
        docs.rs
    </a>
    <br><br>
  <a href="https://docs.rs/ferrisgram"><img src="https://docs.rs/ferrisgram/badge.svg"></a>
  <a href="https://core.telegram.org/bots/api"><img src="https://img.shields.io/badge/Bot%20API-7.5-blue?logo=telegram"></a>
  <a href="https://telegram.me/Ferrisgram"><img src="https://img.shields.io/badge/Telegram-Channel-blue?logo=telegram"></a>
  <a href="https://telegram.me/FerrisgramSupport"><img src="https://img.shields.io/badge/Telegram-Group-blue?logo=telegram"></a>
  <img>
</p>

## **Table of contents**
- [Introduction](#Introduction)
- [Key Features](#Key-Features)
- [Installation](#Installation)
- [Getting Started](#Getting-Started)
- [Documentation](#Documentation)
- [Index](#Index)
- [Contributing](#Contributing)
- [License](#License)

## **Introduction**
FerrisGram is an asynchronous autogenerated wrapper for the Telegram Bot API written in Rust. This library provides all the methods and types that are available on the official Telegram Bot API.

## **Key Features**
- **Latest API support**: Provides support for latest version of Telegram Bot API
- **Easy to use**: Heavily inspired by the python-telegram-bot, Ferrisgram is designed in such a way that even a beginner can make a bot with it easily.
- **Asynchronous**: Ferrisgram is powered by rust's built-in `await` `async` syntax.  
- **Typo Free Docs**: Autogenerated documentations of the native Bot API types and methods make it typo free.
- **Filters**: Ferrisgram provides filters to make it easy for you to sort different type of updates in a managed way.

## **Installation**
You can install ferrisgram by adding the following to `dependencies` section of `Cargo.toml`:
```toml
[dependencies]
ferrisgram = "0.2.0"
```

## **Getting Started**
You can checkout our sample bots in the [examples directory](examples).

## **Documentation**
Documentations can be found at [docs.rs](https://docs.rs/ferrisgram).

## **Index**
- [FerrisGram Generator](generator)
- [Examples Directory](examples)
- [FerrisGram Source Code](src)

## **Contributing**
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update examples as appropriate.


## **License**
[![MIT](https://upload.wikimedia.org/wikipedia/commons/thumb/0/0c/MIT_logo.svg/200px-MIT_logo.svg.png)](https://opensource.org/licenses/MIT)
<br>Licensed Under <a href="https://opensource.org/licenses/MIT">The MIT License</a>