From 235c032062487dc0ddfd6b352f176db60c82e434 Mon Sep 17 00:00:00 2001 From: Francesco Date: Tue, 16 Sep 2025 23:14:28 +0200 Subject: [PATCH] refactor: readme --- README.md | 121 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 63 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 9b0946e..aad8465 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,63 @@ -# tgbot -A minimal C Telegram API Framework - -## Requirements -- meson -- libcurl -- json-c - -> Note: This project is purely educational. It does not aim to cover the entire Telegram Bot API, but only a selected subset of methods. - -## How to build - -
- -Linux - -```bash -$ meson setup build -$ cd build -$ meson compile -$ meson install -``` - -
- -
- -Windows - -Install all the required library with `vcpkg` and then copy the DLL file. - -```powershell -$ meson setup build --native-file meson-vcpkg.txt -$ cd build -$ meson compile -$ meson install -``` - -
- -## Examples -You can find some examples [here](./examples/). - -### Supported Types -- **InlineKeyboardMarkup** - - Note: Standard `KeyboardMarkup` is intentionally not supported. - -#### Supported Methods -- `getMe` -- `sendMessage` -- `editMessageText` -- `sendDice` - -## Roadmap -- `sendPhoto` -- `sendAudio` -- `sendDocument` -- `sendVideo` +# tgbot + +A minimal C Telegram API Framework. + +## Requirements + +- libcurl +- json-c + +> Note: This project is purely educational. It does not aim to cover the entire Telegram Bot API, but only a selected subset of methods. + +## How to build + +
+ +Linux + +```bash +$ meson setup build +$ cd build +$ meson compile +$ meson install +``` + +
+ +
+ +Windows + +Install all the required library with `vcpkg` and then copy the DLL file. + +```powershell +$ meson setup build --native-file meson-vcpkg.txt +$ cd build +$ meson compile +$ meson install +``` + +
+ +## Examples + +You can find some examples [here](./examples/). + +### Supported Types + +- **InlineKeyboardMarkup** + - Note: Standard `KeyboardMarkup` is intentionally not supported. + +#### Supported Methods + +- `getMe` +- `sendMessage` +- `editMessageText` +- `sendDice` + +## Roadmap + +- `sendPhoto` +- `sendAudio` +- `sendDocument` +- `sendVideo`