From 01fbf1609d962961a0067d0a6258348ec0c4ad99 Mon Sep 17 00:00:00 2001 From: Mole Shang <135e2@135e2.dev> Date: Sat, 29 Apr 2023 00:54:11 +0800 Subject: docs: update README --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 36d1ca5..3effc7e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ A Telegram bot that retrives the newest email periodically and sends them to you as chat messages. +## Changes from [upstream](https://github.com/hyfc/telegram-mail-bot) -![Python Version](https://img.shields.io/badge/python-3.6-blue.svg) -[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) \ No newline at end of file +- Replaced POP3 with IMAP protocol (as used more widely) +- Added Docker image hosted on ghcr.io +- Updated code to support python-telegram-bot-20.x APIs +- Added a `/list` query to list all emails received +- Updated deps in Pipfile + +![Python Version](https://img.shields.io/github/pipenv/locked/python-version/135e2/telegram-mail-bot) +[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) +[![Docker Image](https://ghcr-badge.egpl.dev/135e2/telegram-mail-bot/latest_tag)](https://github.com/135e2/telegram-mail-bot/pkgs/container/telegram-mail-bot) -- cgit v1.2.3