From 007a29131b2f78807a35db73da83deb9cc824d0c Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Wed, 24 Jan 2018 10:54:28 +0100 Subject: Update README.md with information Signed-off-by: Joas Schilling --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7ef25e4..1b61b49 100644 --- a/README.md +++ b/README.md @@ -8,20 +8,18 @@ The API is used by other apps to notify users in the web UI and sync clients abo * 🚢 [Update notification](https://github.com/nextcloud/server/tree/master/apps/updatenotification): Available update for an app or nextcloud itself * 📣 [Announcement center](https://github.com/nextcloud/announcementcenter): An announcement was posted by an admin -## QA metrics on master branch: - -[![Build Status](https://travis-ci.org/nextcloud/notifications.svg?branch=master)](https://travis-ci.org/nextcloud/notifications) -[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nextcloud/notifications/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/notifications/?branch=master) -[![Code Coverage](https://scrutinizer-ci.com/g/nextcloud/notifications/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/notifications/?branch=master) - ## Screenshot ![Screenshot of the notification icon and dropdown](https://raw.githubusercontent.com/nextcloud/notifications/master/docs/screenshot.png) -**Note:** -The 🔔 icon is hidden, when the user has no notifications. -## Notification workflow +## Developers + +### Build the notifications app + +To set up this app for development, you need to run `make dev-setup` from within the app´s root folder. If anytime later you need to rebuild the javascript files the quicker `make build-js` is enough. + +### Creating notifications for your app For information how to make your app interact with the notifications app, see [Sending and processing/"mark as read" notifications as a Nextcloud App](https://github.com/nextcloud/notifications/blob/master/docs/notification-workflow.md) -- cgit v1.2.3