diff --git a/.github/example-row.png b/.github/example-row.png new file mode 100644 index 0000000..1ee244b Binary files /dev/null and b/.github/example-row.png differ diff --git a/.github/logo.png b/.github/logo.png index 20d2e30..e3eb90f 100644 Binary files a/.github/logo.png and b/.github/logo.png differ diff --git a/README.md b/README.md index 117d4da..7f6f7d6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,27 @@ - +
+ +

meteorite

+

https://meteorite.surge.sh/

+

Smarter GitHub notifications

+
-> Smarter GitHub notifications. Organize and rank your notifications based on importance and relevance. +## Getting started - +Just visit https://meteorite.surge.sh, log in, and let the notifications roll in as they happen! + +## How it works + + + +## About this project + + - This project is currently hosted on [Surge](https://surge.sh/) + - Built from an ejected [CRA](https://github.com/facebook/create-react-app) app + - Authenticates with the help of [Gatekeeper](https://github.com/prose/gatekeeper) + +# Contributing + +All contributions are welcome, even if its just submitting feedback, giving a suggestion, or reporting a bug. If you're looking to add a feature to Meteorite, make sure you open an issue first (if there's not one open already), and make it known that you're going to be working on it as to avoid multiple people trying to pick up the same issue. ## License