mod: install and quick start

This commit is contained in:
2025-12-23 22:06:14 +03:00
parent 761f37375f
commit 2a3f55fb49

View File

@@ -1,4 +1,4 @@
# etpgrf — Экранный типограф для Web # etpgrf — типограф для Web
[![PyPI version](https://badge.fury.io/py/etpgrf.svg)](https://badge.fury.io/py/etpgrf) [![PyPI version](https://badge.fury.io/py/etpgrf.svg)](https://badge.fury.io/py/etpgrf)
[![Python Version](https://img.shields.io/pypi/pyversions/etpgrf.svg)](https://pypi.org/project/etpgrf/) [![Python Version](https://img.shields.io/pypi/pyversions/etpgrf.svg)](https://pypi.org/project/etpgrf/)
@@ -10,6 +10,22 @@
Экранная типографика для веба — способствует повышению читабельности текста в интернете, Экранная типографика для веба — способствует повышению читабельности текста в интернете,
приближая его к печатной типографике. приближая его к печатной типографике.
## Установка
```bash
pip install etpgrf
```
## Быстрый старт
```python
import etpgrf
# Создаем типограф с настройками по умолчанию
typo = etpgrf.Typographer(langs='ru')
# Обрабатываем текст
result = typo.process(text="\"Пример текста для типографирования!\" - сказал он.")
print(result)
```
### Кодировки и html-мнемоники ### Кодировки и html-мнемоники
Внутри типографа используется кодировка UTF-8. Но при использовании может быть другие кодировки (например, Внутри типографа используется кодировка UTF-8. Но при использовании может быть другие кодировки (например,