From 97f8402c911cf0e20a38b648ecfdfe17e4aa6f7f Mon Sep 17 00:00:00 2001 From: Nicholas Zuber Date: Sun, 11 Nov 2018 16:44:59 -0500 Subject: [PATCH] More readme additions --- README.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7f6f7d6..ffe2105 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@
-

meteorite

-

https://meteorite.surge.sh/

-

Smarter GitHub notifications

+

meteorite

+

https://meteorite.surge.sh/

+

✨ Smarter GitHub notifications 🌱

## Getting started @@ -11,7 +11,30 @@ Just visit https://meteorite.surge.sh, log in, and let the notifications roll in ## How it works - +It's actually pretty simple - we use GitHub's notifications API to get your notifications as they come in, and keep track of relevant heuristics overtime on a per-thread basis, so we know _why_ you're getting a notification and the previous reason's you've gotten it. + +Using this information, we're able to give a score of importantce to each thread based on the history of reasons we saw coming in. For example, a pull request that is assigned to you, has your review requested, and has 30 comments on it, will be scored much higher than an issue you opened up and received a single comment of someone saying "nice" on it. + +We're also able to hook into web notifications to alert you when you get a GitHub notification if you'd want - something like this is totally opt-in. + +Some key features include: + + - Scores your notifications based on their importance, so we can surface the most critical updates at the top of your queue. + - Provides you with quick context for why you're receiving each notification. + - Allows you to opt in for web notifications whenever you recieve important update to help notify you right away. + - Protects you from useless spammy notifications that you don't care about. + - Let's you focus in on specific types of notifications that matter to you, like when your review is requested for a pull request or you were assigned an issue. + - Unlocks dope statistics that help you understand how you interact with notifications on a daily basis. + +
+ +
+ +We're also able to categorize some types of notifications and put a badge on them to help you quickly identify different kinds of issues. We support: + + - Old pull requests that require your review (icon is a green clock). + - Very active threads that get a lot of updates in a short amount of time (icon is a red flame). + - Threads that have a lot of comments and conversation on them (icon is a blue word bubble). ## About this project