andreacavalli
/
TelegramBots
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

1. Update readme

This commit is contained in:
Rubenlagu 2016-01-20 22:18:22 +01:00 committed by Rubenlagus
parent 29f15731e6
commit cc38a3c149
1 changed files with 39 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -1,8 +1,5 @@
# Telegram Bot Java Library
A simple to use library to create Telegram Bots in Java (Still Beta Version)
## Translations
Bots are now supporting multilanguage. If you want to add your own, feel free to translate at [transifex](https://www.transifex.com/projects/p/telegrambots/)
A simple to use library to create Telegram Bots in Java
## Contributions
Feel free to fork this project, work on it and then make a pull request. Most of the times I will accept them if they add something valuable to the code.
@ -10,9 +7,43 @@ Feel free to fork this project, work on it and then make a pull request. Most of
Please, **DO NOT PUSH ANY TOKEN OR API KEY**, I will never accept a pull request with that content.
## Webhooks vs GetUpdates
Both ways are supported (but I still didn't tested webhooks). To change between them, just go to *BuildVars.java* and change variable *useWebHook* value.
Both ways are supported (but I still didn't tested webhooks).
I recommend using getUpdates methods.
## Usage
Just import add the library to your project using [Maven, Gradly, ...](https://jitpack.io/#rubenlagus/TelegramBots/v1.0) or download the jar(including all dependencies) from [here](https://github.com/rubenlagus/TelegramBots/releases/tag/v1.0)
In order to use Long Polling mode, just create your own bot extending `org.telegram.telegrambots.bots.TelegramLongPollingBot`.
If you like to use Webhook, extend `org.telegram.telegrambots.bots.TelegramWebhookBot`
Once done, you just need to creat a `org.telegram.telegrambots.TelegramBotsApi`and register your bots:
```java
// Example taken from https://github.com/rubenlagus/TelegramBotsExample
public class Main {
public static void main(String[] args) {
TelegramBotsApi telegramBotsApi = new TelegramBotsApi();
try {
telegramBotsApi.registerBot(new ChannelHandlers());
telegramBotsApi.registerBot(new DirectionsHandlers());
telegramBotsApi.registerBot(new RaeHandlers());
telegramBotsApi.registerBot(new WeatherHandlers());
telegramBotsApi.registerBot(new TransifexHandlers());
telegramBotsApi.registerBot(new FilesHandlers());
} catch (TelegramApiException e) {
e.printStackTrace();
}
}
}
```
I recommend using getUpdates methods. Webhooks only works using a certificated that is not self-signed
## Example bots
Open them and send them */help* command to get some information about their capabilities:
@ -25,16 +56,14 @@ https://telegram.me/filesbot
https://telegram.me/TGlanguagesbot
You can see code for those bots at [TelegramBotsExample](https://github.com/rubenlagus/TelegramBotsExample) project.
## Telegram Bot API
This library use [Telegram bot API](https://core.telegram.org/bots), you can find more information following the link.
## Questions or Suggestions
Feel free to create issues [here](https://github.com/rubenlagus/TelegramBots/issues) as you need
## Usage with eclipse
Follow the steps created by Rico [here](https://github.com/rubenlagus/TelegramBots/blob/master/eclipse%20configuration.md)
## License
This program is free software: you can redistribute it and/or modify