Skip to content

Commit

Permalink
release 0.34.0 (#219)
Browse files Browse the repository at this point in the history
* release 0.34.0

* update README
  • Loading branch information
ayrat555 authored Sep 19, 2024
1 parent b926de0 commit 91aeb2f
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Changelog

## 0.34.0 (2024-09-19)

- docs: show the required feature on docs.rs by - [#209](https://github.com/ayrat555/frankenstein/pull/209)
- refactor!: flatten the module structure by - [#208](https://github.com/ayrat555/frankenstein/pull/208)
- perf!: always take params reference by - [#211](https://github.com/ayrat555/frankenstein/pull/211)
- refactor!: use MessageOrBool over EditMessageResponse by - [#212](https://github.com/ayrat555/frankenstein/pull/212)
- build!: remove implicit features by - [#214](https://github.com/ayrat555/frankenstein/pull/214)
- Use consistent builder derive configs across API types by - [#213](https://github.com/ayrat555/frankenstein/pull/213)
- test: improve testing for api error response by - [#216](https://github.com/ayrat555/frankenstein/pull/216)
- refactor!: simplify traits with macros by - [#210](https://github.com/ayrat555/frankenstein/pull/210)
- style: group imports by - [#217](https://github.com/ayrat555/frankenstein/pull/217)
- refactor: generalize serde logic into macro by - [#218](https://github.com/ayrat555/frankenstein/pull/218)
- test(error): expect api error by - [#222](https://github.com/ayrat555/frankenstein/pull/222)
- docs: deduplicate spaces by - [#220](https://github.com/ayrat555/frankenstein/pull/220)
- test(json): assert_str by - [#221](https://github.com/ayrat555/frankenstein/pull/221)

## 0.33.0 (2024-09-11)

- refactor!: merge Error and HttpError by @EdJoPaTo - [#204](https://github.com/ayrat555/frankenstein/pull/204)
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "frankenstein"
version = "0.33.0"
version = "0.34.0"
authors = ["Ayrat Badykov <[email protected]>", "EdJoPaTo <[email protected]>", "Pepe Márquez <[email protected]>"]
description = "Telegram bot API client for Rust"
edition = "2021"
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Run `cargo add frankenstein` or add the following to your `Cargo.toml`.

```toml
[dependencies]
frankenstein = "0.33"
frankenstein = "0.34"
```

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

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

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

```toml
frankenstein = { version = "0.33", default-features = false }
frankenstein = { version = "0.34", default-features = false }
```

## Usage
Expand Down Expand Up @@ -188,7 +188,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.33.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.34.0/frankenstein/api_traits/telegram_api/trait.TelegramApi.html#provided-methods)

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

Expand All @@ -204,7 +204,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.33", default-features = false, features = ["telegram-trait"] }
frankenstein = { version = "0.34", 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 91aeb2f

Please sign in to comment.