Released Notes

Released Notes is an Angular package that enables easy integration and display of release notes in Angular applications.

Purpose

The primary purpose of the released-notes package is to offer a seamless solution for showcasing release notes within Angular applications. Whether you're managing frequent updates, major releases, or periodic bug fixes, this package provides an easy-to-use module that enhances communication between development teams and end-users.

By integrating released-notes into your Angular project, you empower your application with a visually appealing and customizable component for displaying release notes. This helps improve transparency, user experience, and collaboration within your development community.

Installation

npm install released-notes

Usage

Add the ReleasedNotesModule to the imports of the module which will be viewing the released notes.

import { ReleasedNotesModule } from 'released-notes';

@NgModule({
  imports: [
    // other modules
    ReleasedNotesModule.forRoot({
      Oid: 'your-organization-id',
      environment: yourAngularEnvironment, // Optional
    }),
  ],
})
export class YourModule {}

Add the element to your HTML:

<released-note></released-note>