From b16691895f772e87418a11621123489794fc08aa Mon Sep 17 00:00:00 2001 From: neko Date: Mon, 27 Jan 2025 11:04:47 +0500 Subject: [PATCH] Add README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2490fd6 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# TG2PDF +This telegram bot converts any libreoffice-supported document into a pdf file. +It uses [pyrogram](https://docs.pyrogram.org/), [libreoffice](https://libreoffice.org) and optionally [unoserver](https://github.com/unoconv/unoserver). +The unoserver dependency is entirely optional - however it improves theoretical processing speed, so its included into Dockerfile by default. + +# Quickstart +```console +git clone https://git.darkn.space/neko/tg2pdf.git +cd tg2pdf +podman build -t tg2pdf . +podman run --name tg2pdf -d tg2pdf:latest +```