diff --git a/documentation/screenshot.png b/documentation/screenshot.png new file mode 100644 index 0000000..7704d4b Binary files /dev/null and b/documentation/screenshot.png differ diff --git a/readme.md b/readme.md index 9b0f5a6..161e57e 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,17 @@ # Github dashboard +Follow multiple repositories and get notifications when someone opens a new pull requests. +Get in one view, build statuses for the repositories and associated pull requests. + +Really helpful when working with multiple repositories in microservice architecture for example. + +Here is an example of the dashboard in action : +![screenshot from the application](documentation/screenshot.png) + +Notes: +* Data consumes only github api (works with private instances of github enterprise) +* Everything is stored locally in your browser + ## Contributing ## Install dependencies