Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alllex committed Oct 3, 2023
1 parent 53ed5d0 commit e752afe
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Telegram Bot API in Kotlin

[![Maven Central](https://img.shields.io/maven-central/v/me.alllex.telegram.botkit/tbot-api-jvm.svg?color=success)](https://central.sonatype.com/namespace/me.alllex.telegram.botkit)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Gradle build](https://github.com/alllex/telegram-bot-kit/actions/workflows/check.yml/badge.svg)](https://github.com/alllex/telegram-bot-kit/actions/workflows/check.yml

Idiomatic, fluent and type-safe Kotlin bindings for [Telegram Bot API](https://core.telegram.org/bots/api).

```kotlin
Expand Down Expand Up @@ -28,6 +32,32 @@ poller.start(TelegramBotUpdateListener(
))
```

## Usage

<details open>
<summary>Using with Gradle for JVM projects</summary>

```kotlin
dependencies {
implementation("me.alllex.telegram.botkit:tbot-api-jvm:0.4.0")
}
```

</details>

<details>
<summary>Using with Maven for JVM projects</summary>

```xml
<dependency>
<groupId>me.alllex.telegram.botkit</groupId>
<artifactId>tbot-api-jvm</artifactId>
<version>0.4.0</version>
</dependency>
```

</details>

## Compatibility

The bindings are generated directly from the source-of-truth [Bot API spec](https://core.telegram.org/bots/api).
Expand Down

0 comments on commit e752afe

Please sign in to comment.