diff --git a/README.md b/README.md index 91164d8..0dfd0f8 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,27 @@ [![Build Status](https://travis-ci.org/ye11ow/noti.svg?branch=master)](https://travis-ci.org/ye11ow/noti) [![Coverage Status](https://coveralls.io/repos/github/ye11ow/noti/badge.svg?branch=master)](https://coveralls.io/github/ye11ow/noti?branch=master) -Noti is a Mac OS X menu bar plugin to show the status of pull requests. It is distributed as a plugin of [bitbar](https://getbitbar.com/). +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/). ## Installation -1. Make sure both `bitbar` and `python3` are installed on your machine. +1. Make sure both `bitbar` and `python3` (>=3.6) are installed on your machine. 1. Clone this repo or just download [`noti.py`](https://raw.githubusercontent.com/ye11ow/noti/master/noti.py) and put it under your bitbar plugin folder. (You may want to edit the shebang of `noti.py` to make sure it points to the right Python interpreter) 1. Rename the `noti.py` to `noti.{time}.py`. The `{time}` is the refresh rate. For instance, `noti.30s.py` will refresh the status every 30 seconds. For detailed instruction, you can refer to https://github.com/matryer/bitbar#configure-the-refresh-time. -1. You should be able to see noti on your menu. Please follow the guide to install the dependencies if you have seen the `Missing dependencies` error. +1. Configure noti to connect to your Gitlab or Github. You can either edit the config file under `$HOME/.noticonfig.json` or select `Configure noti` on the dropdown menu. Please refer to the Configurations section for details. -1. Configure noti to connect to your Gitlab or Github. You can either edit the config file under `$HOME/.noticonfig.json` or select `Configure noti` on the dropdown menu. Please refer to the Configurations section +1. Make sure you have the following dependencies installed (depend on which VCS you want to use) and you should be able to see the status on your menubar. + +* `pip install python-dateutil` (always install this) +* `sudo pip install --upgrade python-gitlab` (for Gitlab) +* `pip install PyGithub` (for Github) ## Configurations ```javascript -// Make sure you remove all the comments before saving the .noticonfig.json file +// Noti will automatically create this file under $HOME/.noticonfig.json if it doesn't exist { // Gitlab related configurations "gitlab": {