summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOleg Morozenkov <m@oleg.rocks>2018-07-23 02:38:36 +0300
committerOleg Morozenkov <m@oleg.rocks>2018-07-23 02:38:36 +0300
commit399eb75d2af1e641fd80b25d1729ef250a66314a (patch)
treef7c3d14d0fe91db3fe291c573c0fbe46559357d2 /README.md
parent98b8b7e4338b71ee46c4301b0bf2ae667be9a99d (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/README.md b/README.md
index c948fbd..0d4ff02 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,7 @@ C++ library for Telegram bot API.
Documentation is located [here](http://reo7sp.github.io/tgbot-cpp).
+
## State
- [x] Bot API 3.0
@@ -27,6 +28,7 @@ Documentation is located [here](http://reo7sp.github.io/tgbot-cpp).
- [x] Bot API 3.5
- [x] Bot API 3.6
+
## Library compilation
Firstly you need to install some dependencies such as Boost and build tools such as CMake. On Debian-based distibutives you can do it with these commands:
@@ -42,9 +44,6 @@ make -j4
sudo make install
```
-### Arch Linux
-
-A PKGBUILD compiles shared library with header files is hosted on [Arch Linux User Repository](https://aur.archlinux.org/packages/libtgbot-cpp-git/).
## Bot compilation
@@ -72,9 +71,16 @@ add_definitions(-DTGBOT_CHANGE_READ_BUFFER_SIZE) # Read Buffer Size Expansion
-DTGBOT_CHANGE_READ_BUFFER_SIZE
```
-### Also
+
+## Specific installation notes
+
+### Docker
You can use Docker to build and run your bot. Set the base image of your's Dockerfile to [reo7sp/tgbot-cpp](https://hub.docker.com/r/reo7sp/tgbot-cpp/).
+### Arch Linux
+A PKGBUILD compiles shared library with header files is hosted on [Arch Linux User Repository](https://aur.archlinux.org/packages/libtgbot-cpp-git/).
+
+
## Samples
Simple echo bot which sends everything it receives:
@@ -108,10 +114,12 @@ int main() {
}
```
-All samples are located [here](samples).
+All other samples are located [here](samples).
+
## Feedback
Feel free to [create new issues on GitHub](https://github.com/reo7sp/tgbot-cpp/issues) or [contact me on Telegram](https://t.me/reo7sp).
+
## Licence
[The MIT License](http://opensource.org/licenses/MIT).