Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/notifications.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2018-01-24 12:54:28 +0300
committerJoas Schilling <coding@schilljs.com>2018-01-24 13:13:21 +0300
commit007a29131b2f78807a35db73da83deb9cc824d0c (patch)
tree65770a8a11ad8b122363408546aef7418d08d6cf /README.md
parentb59df847cf8a6fcc906e97496784d8446f8371f1 (diff)
Update README.md with information
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 7 insertions, 9 deletions
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)