mod: install and quick start
This commit is contained in:
18
README.md
18
README.md
@@ -1,4 +1,4 @@
|
||||
# etpgrf — Экранный типограф для Web
|
||||
# etpgrf — типограф для Web
|
||||
|
||||
[](https://badge.fury.io/py/etpgrf)
|
||||
[](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. Но при использовании может быть другие кодировки (например,
|
||||
|
||||
Reference in New Issue
Block a user