First readme iteration

This commit is contained in:
Nicholas Zuber 2018-11-11 16:35:54 -05:00
parent b88edde312
commit cbc0bccc66
3 changed files with 22 additions and 3 deletions

BIN
.github/example-row.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

BIN
.github/logo.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

@ -1,8 +1,27 @@
<img width="350" src=".github/logo.png" />
<div align="center">
<img width="100" src=".github/logo.png" />
<h2>meteorite</h2>
<h4>https://meteorite.surge.sh/</h4>
<p>Smarter GitHub notifications</p>
</div>
> Smarter GitHub notifications. Organize and rank your notifications based on importance and relevance.
## Getting started
<img width="650" src=".github/template.png" />
Just visit https://meteorite.surge.sh, log in, and let the notifications roll in as they happen!
## How it works
<img width="100" src=".github/example-row.png" />
## 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