Skip to content

Commit

Permalink
Add tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
ye11ow committed Mar 18, 2020
1 parent d20e0c2 commit 4925647
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@

Noti is a Mac OS X menu bar plugin to show the status of pull requests (merge requests). It is distributed as a plugin of [bitbar](https://getbitbar.com/).

![Tutorial](https://github.com/ye11ow/noti/blob/master/docs/images/Bitbar.png?raw=true)

* The background color indicate the status of the CI
* Green: Job passed
* Blue: Job is Running
* Red: Job failed
* Emojis:
* 👍: Pull request is approved
* 🏃: The CI job is running
* 🙃: Number of pull requests that failed the CI job
* 💬: Number of pull reuqest comments

## Installation
1. Make sure both `bitbar` and `python3` (>=3.6) are installed on your machine.

Expand Down

0 comments on commit 4925647

Please sign in to comment.