Skip to content

Commit

Permalink
📝 docs: update README with optional dependencies and formatting
Browse files Browse the repository at this point in the history
Enhanced the README to include more specific optional dependencies
instructions. Improved text formatting for better readability and
clarity.
  • Loading branch information
sudoskys committed Jan 13, 2025
1 parent 408087a commit e04e3a1
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit e04e3a1

Please sign in to comment.