From e752afe6744f4fdfb28ecc9be4228e7051b2c885 Mon Sep 17 00:00:00 2001 From: Alex Semin Date: Tue, 3 Oct 2023 16:43:17 +0200 Subject: [PATCH] Update readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 6f65dd4..979d592 100644 --- a/README.md +++ b/README.md @@ -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 @@ -28,6 +32,32 @@ poller.start(TelegramBotUpdateListener( )) ``` +## Usage + +
+Using with Gradle for JVM projects + +```kotlin +dependencies { + implementation("me.alllex.telegram.botkit:tbot-api-jvm:0.4.0") +} +``` + +
+ +
+Using with Maven for JVM projects + +```xml + + me.alllex.telegram.botkit + tbot-api-jvm + 0.4.0 + +``` + +
+ ## Compatibility The bindings are generated directly from the source-of-truth [Bot API spec](https://core.telegram.org/bots/api).