Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RamIndia committed Oct 27, 2023
1 parent 601100a commit 6720566
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,34 @@ The `@cap-js/notifications` package is a [CDS plugin](https://cap.cloud.sap/docs
### Table of Contents

- [Setup](#setup)
- [Usage](#usage)
- [Update Notification Configuration](#update-notification-configuration)
- [Notification Types Path](#notification-types-path)
- [Notification Type Prefix](#notification-type-prefix)
- [Add Notification Types](#add-notification-types)
- [Add code to send notifications](#add-code-to-send-notifications)
- [Simple Notification with title](#simple-notification-with-title)
- [Simple Notification with title and description](#simple-notification-with-title-and-description)
- [Custom Notifications](#custom-notifications)
- [Add Notification Types](#add-notification-types)
- [Custom Notifications](#custom-notifications)
- [With standard parameters](#with-standard-parameters)
- [Passing the whole notification object](#passing-the-whole-notification-object)
- [Sample Application with notifications](#sample-application-with-notifications)
- [In Local Environment](#in-local-environment)
- [In Production Environment](#in-production-environment)
- [Notification Destination](#notification-destination)
- [Integrate with SAP Build Work Zone](#integrate-with-sap-build-work-zone)
- [Advanced Usage](#advanced-usage)
- [Update Notification Configuration](#update-notification-configuration)
- [Notification Types Path](#notification-types-path)
- [Notification Type Prefix](#notification-type-prefix)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Code of Conduct](#code-of-conduct)
- [Licensing](#licensing)

## Setup

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

```sh
cds add notifications
npm add @cap-js/notifications
```

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

## Usage

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

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

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


#### Notification Types Path

Expand Down

0 comments on commit 6720566

Please sign in to comment.