InsanusMokrassar/tgbotapi
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-24 19:18:44 +00:00
Code Releases Activity

cleanup 'extension' suffix in readmes

Browse Source
This commit is contained in:
InsanusMokrassar 2021-10-18 15:37:10 +06:00
parent dd979d8626
commit 576b25190a
7 changed files with 28 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -17,9 +17,10 @@ Hello! This is a set of libraries for working with Telegram Bot API.
| -------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | -------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Useful links | [![Chat in Telegram](https://img.shields.io/static/v1?label=Talk&message=Telegram&color=blue)](https://t.me/InMoTelegramBotAPI) [![Create bot](https://img.shields.io/static/v1?label=Github&message=Template&color=blue)](https://github.com/InsanusMokrassar/TelegramBotAPI-bot_template/generate) [![KDocs](https://img.shields.io/static/v1?label=Open&message=kdocs&color=blue)](https://tgbotapi.inmo.dev/index.html) [Examples](https://github.com/InsanusMokrassar/TelegramBotAPI-examples/), [Mini tutorial](https://bookstack.inmo.dev/books/telegrambotapi/chapter/introduction-tutorial) | | Useful links | [![Chat in Telegram](https://img.shields.io/static/v1?label=Talk&message=Telegram&color=blue)](https://t.me/InMoTelegramBotAPI) [![Create bot](https://img.shields.io/static/v1?label=Github&message=Template&color=blue)](https://github.com/InsanusMokrassar/TelegramBotAPI-bot_template/generate) [![KDocs](https://img.shields.io/static/v1?label=Open&message=kdocs&color=blue)](https://tgbotapi.inmo.dev/index.html) [Examples](https://github.com/InsanusMokrassar/TelegramBotAPI-examples/), [Mini tutorial](https://bookstack.inmo.dev/books/telegrambotapi/chapter/introduction-tutorial) |
| TelegramBotAPI Core status | [![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 status | [![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 API Extensions status | [![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 API Extensions status | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.api) |
| TelegramBotAPI Util Extensions status | [![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 status | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.utils) |
| TelegramBotAPI Behaviour Builder Extensions status | [![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 status | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.behaviour_builder/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.behaviour_builder) |
| TelegramBotAPI Behaviour Builder Extensions status | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.behaviour_builder.fsm/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.behaviour_builder.fsm) |
| TelegramBotAPI All status | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi) | | TelegramBotAPI All status | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi) |
## Examples ## Examples

33
tgbotapi.api/README.md
View File

@ -1,18 +1,6 @@
# TelegramBotAPI extensions # TelegramBotAPI API extensions
[![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) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.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)
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
## What is it? ## What is it?
@ -28,10 +16,9 @@ This library always compatible with original `tgbotapi.core` library version
Common ways to implement this library are presented here. In some cases it will require additional steps Common ways to implement this library are presented here. In some cases it will require additional steps
like inserting of additional libraries (like `kotlin stdlib`). In the examples will be used variable like inserting of additional libraries (like `kotlin stdlib`). In the examples will be used variable
`telegrambotapi-extensions-api.version`, which must be set up by developer. Available versions are presented on `telegrambotapi-extensions-api.version`, which must be set up by developer.
[bintray](https://bintray.com/insanusmokrassar/TelegramBotAPI/tgbotapi.extensions.api), next version is last published:
[![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.api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.api)
### Maven ### Maven
@ -40,7 +27,7 @@ Dependency config presented here:
```xml ```xml
<dependency> <dependency>
<groupId>dev.inmo</groupId> <groupId>dev.inmo</groupId>
<artifactId>tgbotapi.extensions.api</artifactId> <artifactId>tgbotapi.api</artifactId>
<version>${telegrambotapi-extensions-api.version}</version> <version>${telegrambotapi-extensions-api.version}</version>
</dependency> </dependency>
``` ```
@ -54,13 +41,13 @@ To use last versions you will need to add one line in repositories block of your
And add next line to your dependencies block: And add next line to your dependencies block:
```groovy ```groovy
implementation "dev.inmo:tgbotapi.extensions.api:$telegrambotapi_extensions_api_version" implementation "dev.inmo:tgbotapi.api:$telegrambotapi_extensions_api_version"
``` ```
or for old gradle: or for old gradle:
```groovy ```groovy
compile "dev.inmo:tgbotapi.extensions.api:$telegrambotapi_extensions_api_version" compile "dev.inmo:tgbotapi.api:$telegrambotapi_extensions_api_version"
``` ```
## Example of usage and comparison with `TelegramBotAPI` ## Example of usage and comparison with `TelegramBotAPI`
@ -82,7 +69,7 @@ val bot = telegramBot("IT IS YOUR TOKEN") {
In all examples supposed that you have created bot. In all examples supposed that you have created bot.
| tgbotapi.core | tgbotapi.extensions.api | | tgbotapi.core | tgbotapi.api |
|---------------------|-------------------------------| |---------------------|-------------------------------|
| bot.execute(GetMe) | bot.getMe() | | bot.execute(GetMe) | bot.getMe() |
| bot.execute(SendTextMessage(someChatId, text)) | bot.sendTextMessage(chat, text) | | bot.execute(SendTextMessage(someChatId, text)) | bot.sendTextMessage(chat, text) |
@ -90,8 +77,8 @@ In all examples supposed that you have created bot.
## Updates ## Updates
**Currently, these paragraphs almost outdated due to the fact that extensions for listening of updates and webhooks were **Currently, these paragraphs almost outdated due to the fact that extensions for listening of updates and webhooks were
replaced into `tgbotapi.extensions.utils`. But, most part of information below is correct with small fixes and replaced into `tgbotapi.utils`. But, most part of information below is correct with small fixes and
adding of `tgbotapi.extensions.utils` dependency.** adding of `tgbotapi.utils` dependency.**
Usually, it is more comfortable to use filter object to get separated types of updates: Usually, it is more comfortable to use filter object to get separated types of updates:

4
tgbotapi.behaviour_builder.fsm/README.md
View File

@ -1,8 +1,8 @@
# TelegramBotAPI Behaviour Builder FSM Extensions # TelegramBotAPI Behaviour Builder FSM Extensions
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.behaviour_builder.fsm/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.extensions.behaviour_builder.fsm) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.behaviour_builder.fsm/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.behaviour_builder.fsm)
This extension has been created to integrate finite state machine in [BehaviourBuilder](../tgbotapi.extensions.behaviour_builder/README.md). This extension has been created to integrate finite state machine in [BehaviourBuilder](../tgbotapi.behaviour_builder/README.md).
In case you wish to use some custom store for steps (states), you may extend `StatesManager` or use `DefaultStatesManager` In case you wish to use some custom store for steps (states), you may extend `StatesManager` or use `DefaultStatesManager`
with custom `DefaultStatesManagerRepo`. See [Examples repo](https://github.com/InsanusMokrassar/TelegramBotAPI-examples/tree/master/FSMBot) with custom `DefaultStatesManagerRepo`. See [Examples repo](https://github.com/InsanusMokrassar/TelegramBotAPI-examples/tree/master/FSMBot)
to get more info and see how it works on base level to get more info and see how it works on base level

9
tgbotapi.behaviour_builder/README.md
View File

@ -1,13 +1,6 @@
# TelegramBotAPI Behaviour Builder Extensions # 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) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.behaviour_builder/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.behaviour_builder)
- [TelegramBotAPI Behaviour Builder Extensions](#telegrambotapi-behaviour-builder-extensions)
* [What is it?](#what-is-it)
* [Triggers](#triggers)
* [Waiters](#waiters)
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
## What is it? ## What is it?

2
tgbotapi.core/README.md
View File

@ -106,7 +106,7 @@ requestsExecutor.execute(GetMe())
``` ```
Also there is an alternative syntax for requests (like `requestsExecutor.getMe()` in project Also there is an alternative syntax for requests (like `requestsExecutor.getMe()` in project
[tgbotapi.extensions.api](../tgbotapi.extensions.api/README.md)) [tgbotapi.api](../tgbotapi.api/README.md))
The result type of [GetMe (and getMe extension)](https://github.com/InsanusMokrassar/TelegramBotAPI/blob/master/tgbotapi.core/src/commonMain/kotlin/com/github/insanusmokrassar/tgbotapi/requests/GetMe.kt) The result type of [GetMe (and getMe extension)](https://github.com/InsanusMokrassar/TelegramBotAPI/blob/master/tgbotapi.core/src/commonMain/kotlin/com/github/insanusmokrassar/tgbotapi/requests/GetMe.kt)
request is request is

31
tgbotapi.utils/README.md
View File

@ -1,24 +1,6 @@
# TelegramBotAPI Util Extensions # 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) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.utils)
- [TelegramBotAPI Util Extensions](#telegrambotapi-util-extensions)
* [What is it?](#what-is-it)
* [How to implement library?](#how-to-implement-library)
+ [Maven](#maven)
+ [Gradle](#gradle)
* [How to use?](#how-to-use)
+ [Updates](#updates)
- [Long polling](#long-polling)
- [WebHooks (currently JVM-only)](#webhooks-currently-jvm-only)
+ [Filters](#filters)
- [Sent messages](#sent-messages)
* [Common messages](#common-messages)
* [Chat actions](#chat-actions)
+ [Shortcuts](#shortcuts)
- [ScheduledCloseInfo](#scheduledcloseinfo)
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
## What is it? ## What is it?
@ -28,10 +10,9 @@ It is wrapper library for [TelegramBotAPI Core](../tgbotapi.core/README.md). Cur
Common ways to implement this library are presented here. In some cases it will require additional steps Common ways to implement this library are presented here. In some cases it will require additional steps
like inserting of additional libraries (like `kotlin stdlib`). In the examples will be used variable like inserting of additional libraries (like `kotlin stdlib`). In the examples will be used variable
`telegrambotapi-extensions-utils_version`, which must be set up by developer. Available versions are presented on `telegrambotapi-extensions-utils_version`, which must be set up by developer. Next version is last published:
[bintray](https://bintray.com/insanusmokrassar/TelegramBotAPI/tgbotapi.extensions.utils), next version is last published:
[![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.utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/tgbotapi.utils)
### Maven ### Maven
@ -40,7 +21,7 @@ Dependency config presented here:
```xml ```xml
<dependency> <dependency>
<groupId>dev.inmo</groupId> <groupId>dev.inmo</groupId>
<artifactId>tgbotapi.extensions.utils</artifactId> <artifactId>tgbotapi.utils</artifactId>
<version>${telegrambotapi-extensions-utils_version}</version> <version>${telegrambotapi-extensions-utils_version}</version>
</dependency> </dependency>
``` ```
@ -54,13 +35,13 @@ To use last versions you will need to add one line in repositories block of your
And add next line to your dependencies block: And add next line to your dependencies block:
```groovy ```groovy
implementation "dev.inmo:tgbotapi.extensions.utils:$telegrambotapi-extensions-utils_version" implementation "dev.inmo:tgbotapi.utils:$telegrambotapi-extensions-utils_version"
``` ```
or for old gradle: or for old gradle:
```groovy ```groovy
compile "dev.inmo:tgbotapi.extensions.utils:$telegrambotapi-extensions-utils_version" compile "dev.inmo:tgbotapi.utils:$telegrambotapi-extensions-utils_version"
``` ```
## How to use? ## How to use?

7
tgbotapi/README.md
View File

@ -3,9 +3,10 @@
Concentration of all TelegramBotAPI libraries: Concentration of all TelegramBotAPI libraries:
* [TelegramBotAPI Core](../tgbotapi.core/README.md) * [TelegramBotAPI Core](../tgbotapi.core/README.md)
* [TelegramBotAPI Extensions](../tgbotapi.extensions.api/README.md) * [TelegramBotAPI Extensions](../tgbotapi.api/README.md)
* [TelegramBotAPI Util Extensions](../tgbotapi.extensions.utils/README.md) * [TelegramBotAPI Util Extensions](../tgbotapi.utils/README.md)
* [TelegramBotAPI Behaviour Builder Extensions](../tgbotapi.extensions.behaviour_builder/README.md) * [TelegramBotAPI Behaviour Builder Extensions](../tgbotapi.behaviour_builder/README.md)
* [TelegramBotAPI Behaviour Builder FSM Extensions](../tgbotapi.behaviour_builder.fsm/README.md)
## Implementation ## Implementation