diff --git a/README.md b/README.md index c8ed2c416f..1a4669ec73 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ # TelegramBotAPI +- [TelegramBotAPI](#telegrambotapi) + * [Examples](#examples) + + [Most common example](#most-common-example) + + [Handling only last messages](#handling-only-last-messages) + + [Build a little bit more complex behaviour](#build-a-little-bit-more-complex-behaviour) + + [More examples](#more-examples) + +Table of contents generated with markdown-toc + Hello! This is a set of libraries for working with Telegram Bot API. | Common info | [![Awesome Kotlin Badge](https://kotlin.link/awesome-kotlin.svg)](https://github.com/KotlinBy/awesome-kotlin) [![Build Status](https://github.com/InsanusMokrassar/TelegramBotAPI/workflows/Build/badge.svg)](https://github.com/InsanusMokrassar/TelegramBotAPI/actions) [Small survey](https://forms.gle/2Hex2ynbHWHhi1KY7)| diff --git a/tgbotapi.core/README.md b/tgbotapi.core/README.md index f4eeda039d..4f888a0d23 100644 --- a/tgbotapi.core/README.md +++ b/tgbotapi.core/README.md @@ -2,6 +2,20 @@ [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.core) +- [TelegramBotAPI Core](#telegrambotapi-core) + * [What is it?](#what-is-it-) + * [Compatibility](#compatibility) + * [How to implement library?](#how-to-implement-library-) + + [Maven](#maven) + + [Gradle](#gradle) + * [How to work with library?](#how-to-work-with-library-) + + [Types](#types) + + [Requests](#requests) + + [RequestsExecutor](#requestsexecutor) + + [Passport](#passport) + +Table of contents generated with markdown-toc + ## What is it? Library for Object-Oriented and type-safe work with Telegram Bot API. Most part of some specific solves or unuseful diff --git a/tgbotapi.extensions.api/README.md b/tgbotapi.extensions.api/README.md index 63b706e7b7..dd013db501 100644 --- a/tgbotapi.extensions.api/README.md +++ b/tgbotapi.extensions.api/README.md @@ -1,8 +1,19 @@ # TelegramBotAPI extensions -[![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/tgbotapi.extensions.api/images/download.svg) ](https://bintray.com/insanusmokrassar/TelegramBotAPI/tgbotapi.extensions.api/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.api) +- [TelegramBotAPI extensions](#telegrambotapi-extensions) + * [What is it?](#what-is-it-) + * [Compatibility](#compatibility) + * [How to implement library?](#how-to-implement-library-) + + [Maven](#maven) + + [Gradle](#gradle) + * [Example of usage and comparison with `TelegramBotAPI`](#example-of-usage-and-comparison-with--telegrambotapi-) + * [Updates](#updates) + + [Alternative way](#alternative-way) + +Table of contents generated with markdown-toc + ## What is it? It is wrapper library for [TelegramBotAPI Core](../tgbotapi.core/README.md). Here you can find extensions for diff --git a/tgbotapi.extensions.behaviour_builder/README.md b/tgbotapi.extensions.behaviour_builder/README.md index c618a07ce8..537863d68e 100644 --- a/tgbotapi.extensions.behaviour_builder/README.md +++ b/tgbotapi.extensions.behaviour_builder/README.md @@ -1,5 +1,16 @@ # TelegramBotAPI Behaviour Builder Extensions +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.behaviour_builder/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.behaviour_builder) + +- [TelegramBotAPI Behaviour Builder Extensions](#telegrambotapi-behaviour-builder-extensions) + * [What is it?](#what-is-it-) + * [Triggers](#triggers) + * [Waiters](#waiters) + +Table of contents generated with markdown-toc + +## What is it? + This extension was created to make it more simple to build bot steps handling. Usually, you must use something like: ```kotlin diff --git a/tgbotapi.extensions.utils/README.md b/tgbotapi.extensions.utils/README.md index aa10cd0b86..fd923df039 100644 --- a/tgbotapi.extensions.utils/README.md +++ b/tgbotapi.extensions.utils/README.md @@ -1,5 +1,6 @@ # TelegramBotAPI Util Extensions +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.utils) - [TelegramBotAPI Util Extensions](#telegrambotapi-util-extensions) * [What is it?](#what-is-it) @@ -19,9 +20,6 @@ Table of contents generated with markdown-toc -[![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/tgbotapi.extensions.utils/images/download.svg) ](https://bintray.com/insanusmokrassar/TelegramBotAPI/tgbotapi.extensions.utils/_latestVersion) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.utils) - ## What is it? It is wrapper library for [TelegramBotAPI Core](../tgbotapi.core/README.md). Currently, this library contains some usefull filters for commands, updates types and different others.