refactor: readme

README.md

@@ -1,58 +1,63 @@
-# tgbot
+# tgbot
-A minimal C Telegram API Framework
+
-
+A minimal C Telegram API Framework.
-## Requirements
+
-- meson
+## Requirements
-- libcurl
+
-- json-c
+- 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.
+
-
+> 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
+
-
+## How to build
-<details>
+
-
+<details>
-<summary>Linux</summary>
+
-
+<summary>Linux</summary>
-```bash
+
-$ meson setup build
+```bash
-$ cd build
+$ meson setup build
-$ meson compile
+$ cd build
-$ meson install
+$ meson compile
-```
+$ meson install
-
+```
-</details>
+
-
+</details>
-<details>
+
-
+<details>
-<summary>Windows</summary>
+
-
+<summary>Windows</summary>
-Install all the required library with `vcpkg` and then copy the DLL file.
+
-
+Install all the required library with `vcpkg` and then copy the DLL file.
-```powershell
+
-$ meson setup build --native-file meson-vcpkg.txt
+```powershell
-$ cd build
+$ meson setup build --native-file meson-vcpkg.txt
-$ meson compile
+$ cd build
-$ meson install
+$ meson compile
-```
+$ meson install
-
+```
-</details>
+
-
+</details>
-## Examples
+
-You can find some examples [here](./examples/).
+## Examples
-
+
-### Supported Types
+You can find some examples [here](./examples/).
-- **InlineKeyboardMarkup**
+
-  - Note: Standard `KeyboardMarkup` is intentionally not supported.
+### Supported Types
-
+
-#### Supported Methods
+- **InlineKeyboardMarkup**
-- `getMe`
+  - Note: Standard `KeyboardMarkup` is intentionally not supported.
-- `sendMessage`
+
-- `editMessageText`
+#### Supported Methods
-- `sendDice`
+
-
+- `getMe`
-## Roadmap
+- `sendMessage`
-- `sendPhoto`
+- `editMessageText`
-- `sendAudio`
+- `sendDice`
-- `sendDocument`
+
-- `sendVideo`
+## Roadmap
+
+- `sendPhoto`
+- `sendAudio`
+- `sendDocument`
+- `sendVideo`