Skip to content

Commit

Permalink
chore: update readme.md (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
mhkafadar committed Jan 21, 2024
1 parent 9180e5d commit ae53d44
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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**

Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit ae53d44

Please sign in to comment.