hipalanet-notificationsjs

Synopsis

hipalanet-notificationnjs is a javascript engine to integrate chat in your site with only few steps.

Instalation

To use hipalanet-notificationsjs in your project install it via npm:

npm i hipalanet-notificationsjs --save

Usage

Account initialization

Navigate to notifications admin and sign you up.

Add Notification Group

You must access the menu option Notification Groups and create your first group.

Notification Groups are like applications or sites. So, generally speaking each of your applications will have it own Notification Groups

Code Example

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

Motivation

A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.

Installation

npm install hipalanet-notificationsjs

API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

Tests

Describe and show how to run the tests with code examples.

Contributors

HiPalanet

License

Apache