Skip to content

Commit

Permalink
docs: simplify installation instructions
Browse files Browse the repository at this point in the history
- cargo add is a helpful tool
- 0.30 automatically installs bugfix versions so remove the .1 suffix
  • Loading branch information
EdJoPaTo committed Jan 8, 2024
1 parent 70c4922 commit 06a5f2c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Frankenstein's data structures (rust structs and enums) are mapped one-to-one fr

## Installation

Add this to your `Cargo.toml`.
Run `cargo add frankenstein` or add the following to your `Cargo.toml`.

```toml
[dependencies]
frankenstein = "0.30.1"
frankenstein = "0.30"
```

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

```toml
frankenstein = { version = "0.30.1", default-features = false, features = ["async-http-client"] }
frankenstein = { version = "0.30", 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.30.1", default-features = false }
frankenstein = { version = "0.30", default-features = false }
```

## Usage
Expand Down Expand Up @@ -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.30.1", default-features = false, features = ["telegram-trait"] }
frankenstein = { version = "0.30", 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 06a5f2c

Please sign in to comment.