@openfin/web-notifications 2.9.1-alpha-3944

package/README.md

@@ -0,0 +1,55 @@
+<!-- README for NPM; the one for GitHub is in .github directory. -->
+
+# Here™ Web Notification Center
+
+## Overview
+
+The **Here™ Web Notification Center** offers a consistent and streamlined way for developers to create, display, and manage desktop notifications. It also supports handling notification events seamlessly within a web browser.
+
+All notifications are displayed, categorized, and managed within a centralized Notification Center UI.
+
+## Getting Started
+
+To integrate the Notification Center into your application, install the Here™ Web Notification Center package.
+
+### Import the Web Notification Center
+
+```bash
+npm install @openfin/web-notifications
+```
+
+### Set Up the Core-Web Fin Context
+
+Before using the Notification Center, ensure your application is configured with a `fin` context from the `@openfin/core-web` package.
+This context provides the necessary runtime connection and environment information.
+
+For setup instructions, refer to the [@openfin/core-web](https://www.npmjs.com/package/@openfin/core-web) documentation.
+
+### Usage
+
+Add a container `<div>` in your HTML with a specific ID (e.g., `id="notification_center_container"`).
+
+> **Note:** The Notification Center UI is optimized for containers that are 345px wide.
+
+Initialize the Notification Center by importing the module and passing in the required options, including the `finContext`, `serviceId`, and the container element.
+The `serviceId` will be used by the client library to connect to the notification service.
+Optional parameters such as a custom theme or a session snapshot can also be provided.
+
+```ts
+import { initiNotificationCenter } from '@openfin/web-notifications';
+
+const notificationCenterContainer = document.querySelector<HTMLElement>(
+  '#notification_center_container'
+);
+
+// initialize fin context.
+
+// initialize the notification center.
+await initNotificationCenter({
+  finContext: fin,
+  serviceId: 'notification-center-service-channel',
+  container: notificationCenterContainer,
+  theme: myTheme,
+  snapshot: myPreviousSessionSnapshot
+});
+```