aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMole Shang <[email protected]>2023-04-29 00:54:11 +0800
committerMole Shang <[email protected]>2023-04-29 00:54:51 +0800
commit01fbf1609d962961a0067d0a6258348ec0c4ad99 (patch)
treeb91ea8817c0a04e02617e8ba312dc3bf0d494aa5 /README.md
parent33731ddc2e70a11c5d0fafb56edb79b1ac60236e (diff)
downloadtelegram-mail-bot-01fbf1609d962961a0067d0a6258348ec0c4ad99.tar.gz
telegram-mail-bot-01fbf1609d962961a0067d0a6258348ec0c4ad99.tar.bz2
telegram-mail-bot-01fbf1609d962961a0067d0a6258348ec0c4ad99.zip
docs: update READMEHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files 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)