From 2a3f55fb4963438765b25bb77c45374860205794 Mon Sep 17 00:00:00 2001 From: erjemin Date: Tue, 23 Dec 2025 22:06:14 +0300 Subject: [PATCH] mod: install and quick start --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d1eba5..0b4061f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# etpgrf — Экранный типограф для Web +# etpgrf — типограф для Web [![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/) @@ -10,6 +10,22 @@ Экранная типографика для веба — способствует повышению читабельности текста в интернете, приближая его к печатной типографике. +## Установка + +```bash +pip install etpgrf +``` +## Быстрый старт + +```python +import etpgrf +# Создаем типограф с настройками по умолчанию +typo = etpgrf.Typographer(langs='ru') +# Обрабатываем текст +result = typo.process(text="\"Пример текста для типографирования!\" - сказал он.") +print(result) +``` + ### Кодировки и html-мнемоники Внутри типографа используется кодировка UTF-8. Но при использовании может быть другие кодировки (например,