From e04e3a1e509b0470f56ff4d6b56a0eefc62b6088 Mon Sep 17 00:00:00 2001 From: sudoskys Date: Mon, 13 Jan 2025 17:55:02 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20update=20README=20with?= =?UTF-8?q?=20optional=20dependencies=20and=20formatting?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Enhanced the README to include more specific optional dependencies instructions. Improved text formatting for better readability and clarity. --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 81da43d..2bd7369 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,8 @@ or, if you use `pdm`: ```shell pdm add telegramify-markdown pdm add telegramify-markdown -G mermaid -# -G -> https://pdm-project.org/en/latest/reference/pep621/#optional-dependencies +# -G mermaid -G tests +# -> https://pdm-project.org/en/latest/reference/pep621/#optional-dependencies ``` ### 🤔 What you want to do? @@ -53,9 +54,10 @@ We have two main functions: `markdownify` and `telegramify`. `markdownify`: Just converts raw Markdown text to Telegram's MarkdownV2 format. -`telegramify`: Spilt long text into multiple chunks, convert format and use Interpreter to render code block to File, Image etc. +`telegramify`: Spilt long text into multiple chunks, convert format and use Interpreter to render code block to File, +Image etc. ->`Interpreter` can be easily customized to inspect the rendering process in `telegramify`. +> `Interpreter` can be easily customized to inspect the rendering process in `telegramify`. ## 👀 Use case @@ -150,7 +152,8 @@ print(converted) ### `telegramify` -please check: [playground/telegramify_case.py](https://github.com/sudoskys/telegramify-markdown/blob/main/playground/telegramify_case.py) +please +check: [playground/telegramify_case.py](https://github.com/sudoskys/telegramify-markdown/blob/main/playground/telegramify_case.py) ## 🔨 Supported Input