From ae53d448fd5646fda051b57cee0d8d7b1eeb24e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mehmet=20H=C3=BCseyin=20Kafadar?= <43652059+mhkafadar@users.noreply.github.com> Date: Sun, 19 Mar 2023 00:50:32 +0300 Subject: [PATCH] chore: update readme.md (#23) --- README.md | 30 ++++++++++++++++++++++++------ _config.yml | 4 ++-- 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 29715ca..b076634 100644 --- a/README.md +++ b/README.md @@ -12,22 +12,40 @@ Bots for Telegram. Get notifications on new events like new commits, pipelines, Notifine helps with events in your work tools like Gitlab, Github, and Trello. Just send a message to notifine or add it to your telegram group. It will provide you with a webhook link right away. Copy this link and paste it to your favorite tool (only GitLab now). - 🤖 [Gitlab bot](https://t.me/git_events_bot) -- 🧭 Github bot (Soon) +- 🤖 [Github bot](https://t.me/github_notifine_bot) - 🧭 Trello bot (Soon) --- +**Mar 18, 2023: Github bot has started working!** + **Dec 04, 2022: Gitlab bot has started working!** -Available notifications: Push, Tag push, Issue, Comments on Issues +--- -Notifications will be available with the next releases: Pipeline, Jobs, Wiki, Comments +## Available Notifications ---- +### GitHub + + ✅ Commit push + ✅ Branch creation, deletion + ✅ Issue creation, issue update + + +### GitLab + + ✅ Commit push + ✅ Tag push + +### Coming Soon + +⏳ Pipeline notifications (April) +⏳ Pull request notifications (April) +⏳ Deployment notifications (April) ## ✨ Features -**⚡️😎 100% open source and free** +**😎 100% open source and free** Backend (Rust) and infrastructure codes (AWS CDK) are open sources. @@ -37,7 +55,7 @@ There are some telegram bots available already. But they are not able to provide **🎓 Educational purposes** -I am planning to prepare a tutorial based on this project. And help new Rustaceans with an up to date Rust implementation. +I am planning to prepare a tutorial based on this project. And help new Rustaceans with an up-to-date Rust implementation. **⚡️ Built on Rust** diff --git a/_config.yml b/_config.yml index 88e2973..458825f 100644 --- a/_config.yml +++ b/_config.yml @@ -1,5 +1,5 @@ -title: notifine -description: Bots for Telegram. Get notifications on new events like new commits, pipelines, etc. +title: notifine - Reliable Telegram notifications for Github and Gitlab +description: Instant Github, Gitlab notifications for Telegram show_downloads: false google_analytics: remote_theme: pages-themes/cayman@v0.2.0