# optify-notify

> The Optify Notify SDK is a JavaScript library designed for seamless integration with the Optify notification infrastructure. It enables developers to effortlessly send notifications to users on the Optify platform.

Latest version **1.0.1** (published 2024-01-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install optify-notify
pnpm add optify-notify
yarn add optify-notify
bun add optify-notify
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-01-27 |
| First published | 2024-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 12.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | mohit_aasirwal |

## Links

- npm: https://www.npmjs.com/package/optify-notify
- npm.io page: https://npm.io/package/optify-notify

## Dependencies (2)

- [npmrc](https://npm.io/package/npmrc.md) ^1.1.1
- [@novu/node](https://npm.io/package/@novu/node.md) ^0.22.0

## Recent versions

- 1.0.1 (latest) — 2024-01-27
- 1.0.0 — 2024-01-27

## README

# Optify Notify SDK

The Optify Notify SDK is a JavaScript library designed for seamless integration with the Optify notification infrastructure. It enables developers to effortlessly send notifications to users on the Optify platform.

## Table of Contents

- [Installation](#installation)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Contributing](#contributing)
- [License](#license)

## Installation

To integrate Optify Notify SDK into your project, install it using npm:

```bash
npm install optify-notify-sdk
```

# Getting Started

To begin using the Optify Notify SDK, you need an API key. Contact the Optify team to obtain your API key.

## Usage

### Initialization

```const OptifyNotify = require('optify-notify-sdk');

// Replace 'your-api-key' with your actual API key
const optifyNotify = new OptifyNotify({
  apiKey: 'your-api-key',
});
```

## Sending Notifications

```// Replace 'userAddress' with the recipient's Ethereum address
const userAddress = '0x123abc';

// Replace 'message' with the content of the notification
const message = 'Hello from Optify!';

// Send a notification
optifyNotify.sendNotification(userAddress, message)
  .then(response => {
    console.log('Notification sent successfully:', response);
  })
  .catch(error => {
    console.error('Error sending notification:', error);
  });
```

## API Reference

OptifyNotify(options)
Creates a new instance of the Optify Notify SDK.

options (object): Configuration options.
apiKey (string, required): Your Optify API key.
optifyNotify.sendNotification(userAddress, message)
Sends a notification to the specified user.

userAddress (string): The Ethereum address of the notification recipient.
message (string): The content of the notification.
Returns a Promise that resolves when the notification is successfully sent.

## Contributing

We welcome contributions from the community! To contribute to the Optify Notify SDK, please follow our contribution guidelines.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

Please replace the placeholder values with your actual API key and customize the content further based on your specific project details. Consider adding more sections or details as needed for your Optify Notify SDK.

---
_Source: https://npm.io/package/optify-notify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._