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

fixes in readmes

Browse Source
This commit is contained in:
InsanusMokrassar 2020-10-04 17:41:30 +06:00
parent 959136479e
commit 7478b151eb
5 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -3,10 +3,10 @@
| Common info | [![Awesome Kotlin Badge](https://kotlin.link/awesome-kotlin.svg)](https://github.com/KotlinBy/awesome-kotlin) [![Build Status](https://travis-ci.com/InsanusMokrassar/TelegramBotAPI.svg?branch=master)](https://travis-ci.com/InsanusMokrassar/TelegramBotAPI) [Small survey](https://forms.gle/tnjuExdSKEr32ygKA)|
| -------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Useful links | [![Chat in Telegram](badges/chat.svg)](https://t.me/InMoTelegramBotAPI) [![KDocs](badges/kdocs.svg)](https://tgbotapi.inmo.dev/docs/index.html) [Examples](https://github.com/InsanusMokrassar/TelegramBotAPI-examples/), [Mini tutorial](https://bookstack.inmo.dev/books/telegrambotapi/chapter/introduction-tutorial) |
| TelegramBotAPI Core status | [![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-core/images/download.svg)](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-core/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI) |
| TelegramBotAPI Extensions status | [![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-api/images/download.svg)](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-api/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-extensions-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-extensions-api) |
| TelegramBotAPI Util Extensions status | [![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-utils/images/download.svg)](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-utils/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-extensions-utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-extensions-utils) |
| TelegramBotAPI All status | [![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI/images/download.svg)](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-all) |
| TelegramBotAPI Core status | [![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-core/images/download.svg)](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-core/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI) |
| TelegramBotAPI Extensions status | [![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-api/images/download.svg)](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-api/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-extensions-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-extensions-api) |
| TelegramBotAPI Util Extensions status | [![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-utils/images/download.svg)](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-utils/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-extensions-utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-extensions-utils) |
| TelegramBotAPI All status | [![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI/images/download.svg)](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-all) |
**At the time of publication of version `0.28.0` there are errors in serialization plugins like
[kotlinx.serialization#1004](https://github.com/Kotlin/kotlinx.serialization/issues/1004). It is possible, that both JVM
@ -40,9 +40,9 @@ In case if you are want to use this library inside of browser, you will need add
dependencies {
/* ... */
implementation "dev.inmo.tgbotapi:TelegramBotAPI:$tgbot_api_version"
implementation "dev.inmo.tgbotapi:TelegramBotAPI-extensions-api:$tgbot_api_version" // optional
implementation "dev.inmo.tgbotapi:TelegramBotAPI-extensions-utils:$tgbot_api_version" // optional
implementation "dev.inmo:TelegramBotAPI:$tgbot_api_version"
implementation "dev.inmo:TelegramBotAPI-extensions-api:$tgbot_api_version" // optional
implementation "dev.inmo:TelegramBotAPI-extensions-utils:$tgbot_api_version" // optional
/* Block of dependencies for correct building in browser */
implementation(npm("fs"))

10
TelegramBotAPI-core/README.md
View File

@ -1,7 +1,7 @@
# TelegramBotAPI-core
[![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-core/images/download.svg) ](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-core/_latestVersion)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI)
## What is it?
@ -28,7 +28,7 @@ Currently, last versions of library can be available from the Maven repository w
of signed artifacts in Bintray). You can:
* Use earlier version (available version you can find
[here](https://mvnrepository.com/artifact/dev.inmo.tgbotapi/TelegramBotAPI) (before 0.28.0) or [here](https://mvnrepository.com/artifact/dev.inmo.tgbotapi/TelegramBotAPI-core))
[here](https://mvnrepository.com/artifact/dev.inmo/TelegramBotAPI) (before 0.28.0) or [here](https://mvnrepository.com/artifact/dev.inmo/TelegramBotAPI-core))
* Add `jCenter` repository in build config
### Maven
@ -37,7 +37,7 @@ Dependency config presented here:
```xml
<dependency>
<groupId>dev.inmo.tgbotapi</groupId>
<groupId>dev.inmo</groupId>
<artifactId>TelegramBotAPI-core</artifactId>
<version>${telegrambotapi.version}</version>
</dependency>
@ -52,13 +52,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:
```groovy
implementation "dev.inmo.tgbotapi:TelegramBotAPI-core:$telegrambotapi_version"
implementation "dev.inmo:TelegramBotAPI-core:$telegrambotapi_version"
```
or for old gradle:
```groovy
compile "dev.inmo.tgbotapi:TelegramBotAPI-core:$telegrambotapi_version"
compile "dev.inmo:TelegramBotAPI-core:$telegrambotapi_version"
```
## How to work with library?

8
TelegramBotAPI-extensions-api/README.md
View File

@ -1,7 +1,7 @@
# TelegramBotAPI extensions
[![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-api/images/download.svg) ](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-api/_latestVersion)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-extensions-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-extensions-api)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-extensions-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-extensions-api)
## What is it?
@ -28,7 +28,7 @@ Dependency config presented here:
```xml
<dependency>
<groupId>dev.inmo.tgbotapi</groupId>
<groupId>dev.inmo</groupId>
<artifactId>TelegramBotAPI-extensions-api</artifactId>
<version>${telegrambotapi-extensions-api.version}</version>
</dependency>
@ -43,13 +43,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:
```groovy
implementation "dev.inmo.tgbotapi:TelegramBotAPI-extensions-api:$telegrambotapi_extensions_api_version"
implementation "dev.inmo:TelegramBotAPI-extensions-api:$telegrambotapi_extensions_api_version"
```
or for old gradle:
```groovy
compile "dev.inmo.tgbotapi:TelegramBotAPI-extensions-api:$telegrambotapi_extensions_api_version"
compile "dev.inmo:TelegramBotAPI-extensions-api:$telegrambotapi_extensions_api_version"
```
## Example of usage and comparison with `TelegramBotAPI`

8
TelegramBotAPI-extensions-utils/README.md
View File

@ -20,7 +20,7 @@
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
[![Download](https://api.bintray.com/packages/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-utils/images/download.svg) ](https://bintray.com/insanusmokrassar/TelegramBotAPI/TelegramBotAPI-extensions-utils/_latestVersion)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-extensions-utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo.tgbotapi/TelegramBotAPI-extensions-utils)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-extensions-utils/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/TelegramBotAPI-extensions-utils)
## What is it?
@ -41,7 +41,7 @@ Dependency config presented here:
```xml
<dependency>
<groupId>dev.inmo.tgbotapi</groupId>
<groupId>dev.inmo</groupId>
<artifactId>TelegramBotAPI-extensions-utils</artifactId>
<version>${telegrambotapi-extensions-utils_version}</version>
</dependency>
@ -56,13 +56,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:
```groovy
implementation "dev.inmo.tgbotapi:TelegramBotAPI-extensions-utils:$telegrambotapi-extensions-utils_version"
implementation "dev.inmo:TelegramBotAPI-extensions-utils:$telegrambotapi-extensions-utils_version"
```
or for old gradle:
```groovy
compile "dev.inmo.tgbotapi:TelegramBotAPI-extensions-utils:$telegrambotapi-extensions-utils_version"
compile "dev.inmo:TelegramBotAPI-extensions-utils:$telegrambotapi-extensions-utils_version"
```
## How to use?

2
TelegramBotAPI/README.md
View File

@ -11,6 +11,6 @@ Concentration of all TelegramBotAPI libraries:
```groovy
dependencies {
// ...
implementation "dev.inmo.tgbotapi:TelegramBotAPI:$tgBotAPIVersion"
implementation "dev.inmo:TelegramBotAPI:$tgBotAPIVersion"
}
```