Skip to content

Commit

Permalink
release 0.37.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ayrat555 committed Dec 7, 2024
1 parent e9a799f commit 1f7e741
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Telegram bot API client for Rust.

It's a complete wrapper for Telegram bot API, and it's up-to-date with version 8.0 of the API.
It's a complete wrapper for Telegram bot API, and it's up-to-date with version 8.1 of the API.

Frankenstein's data structures (rust structs and enums) are mapped one-to-one from Telegram bot API objects and method parameters.

Expand All @@ -16,7 +16,7 @@ Run `cargo add frankenstein` or add the following to your `Cargo.toml`.

```toml
[dependencies]
frankenstein = "0.36"
frankenstein = "0.37"
```

## Features
Expand All @@ -34,15 +34,15 @@ frankenstein = "0.36"
To use the async client add the following line to your `Cargo.toml` file:

```toml
frankenstein = { version = "0.36", default-features = false, features = ["async-http-client"] }
frankenstein = { version = "0.37", default-features = false, features = ["async-http-client"] }
```

The async client partially supports wasm32 target, file uploads in the wasm32 target are not supported.

You can also disable all features. In this case the crate will ship only with Telegram types.

```toml
frankenstein = { version = "0.36", default-features = false }
frankenstein = { version = "0.37", default-features = false }
```

## Usage
Expand Down Expand Up @@ -190,7 +190,7 @@ AsyncApi::builder().api_url(api_url).client(client).build()

### Documentation

Frankenstein implements all Telegram bot API methods. To see which parameters you should pass, check [docs.rs](https://docs.rs/frankenstein/0.36.0/frankenstein/api_traits/telegram_api/trait.TelegramApi.html#provided-methods)
Frankenstein implements all Telegram bot API methods. To see which parameters you should pass, check [docs.rs](https://docs.rs/frankenstein/0.37.0/frankenstein/api_traits/telegram_api/trait.TelegramApi.html#provided-methods)

You can check out real-world bots created using this library:

Expand All @@ -206,7 +206,7 @@ The library uses `ureq` HTTP client by default, but it can be easily replaced wi
`ureq` comes with a default feature (`impl`). So the feature should be disabled.

```toml
frankenstein = { version = "0.36", default-features = false, features = ["telegram-trait"] }
frankenstein = { version = "0.37", default-features = false, features = ["telegram-trait"] }
```

Then implement the `TelegramApi` trait for your HTTP client which requires two functions:
Expand Down

0 comments on commit 1f7e741

Please sign in to comment.