Skip to content

Commit 6720566

Browse files
committed
updating readme
1 parent 601100a commit 6720566

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,34 @@ The `@cap-js/notifications` package is a [CDS plugin](https://cap.cloud.sap/docs
77
### Table of Contents
88

99
- [Setup](#setup)
10-
- [Usage](#usage)
11-
- [Update Notification Configuration](#update-notification-configuration)
12-
- [Notification Types Path](#notification-types-path)
13-
- [Notification Type Prefix](#notification-type-prefix)
14-
- [Add Notification Types](#add-notification-types)
1510
- [Add code to send notifications](#add-code-to-send-notifications)
1611
- [Simple Notification with title](#simple-notification-with-title)
1712
- [Simple Notification with title and description](#simple-notification-with-title-and-description)
18-
- [Custom Notifications](#custom-notifications)
13+
- [Add Notification Types](#add-notification-types)
14+
- [Custom Notifications](#custom-notifications)
1915
- [With standard parameters](#with-standard-parameters)
2016
- [Passing the whole notification object](#passing-the-whole-notification-object)
2117
- [Sample Application with notifications](#sample-application-with-notifications)
2218
- [In Local Environment](#in-local-environment)
2319
- [In Production Environment](#in-production-environment)
2420
- [Notification Destination](#notification-destination)
2521
- [Integrate with SAP Build Work Zone](#integrate-with-sap-build-work-zone)
22+
- [Advanced Usage](#advanced-usage)
23+
- [Update Notification Configuration](#update-notification-configuration)
24+
- [Notification Types Path](#notification-types-path)
25+
- [Notification Type Prefix](#notification-type-prefix)
2626
- [Contributing](#contributing)
27-
- [Code of Conduct](#code-of-conduct)
27+
- [Code of Conduct](#code-of-conduct)
2828
- [Licensing](#licensing)
2929

3030
## Setup
3131

3232
To enable notifications, simply add this self-configuring plugin package to your project:
3333

3434
```sh
35-
cds add notifications
35+
npm add @cap-js/notifications
3636
```
3737

38-
<img width="1300" alt="cds add notifications" style="border-radius:0.5rem" src="_assets/cdsAddNotifications.gif">
39-
4038
## Usage
4139

4240
In this guide, we use the [Incidents Management reference sample app](https://github.com/cap-js/incidents-app) as the base, to publish notifications.
@@ -45,7 +43,7 @@ In this guide, we use the [Incidents Management reference sample app](https://gi
4543

4644
`cds add notifications` will add default configurations for notifications in the `package.json` file.
4745

48-
<img width="1300" alt="Default Notification config" style="border-radius:0.5rem" src="_assets/packageJsonConfig.gif">
46+
4947

5048
#### Notification Types Path
5149

0 commit comments

Comments
 (0)