Skip to content

Commit dd3822d

Browse files
authored
refactor: Rename package name and update the js sdk package to latest
1 parent d2e0c90 commit dd3822d

File tree

15 files changed

+96
-17988
lines changed

15 files changed

+96
-17988
lines changed

CHANGELOG.md

Lines changed: 2 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,54 +2,8 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
## [Unreleased]
5+
## [0.0.1] - 2024-03-26
66

77
### Added
88

9-
- New feature or enhancement.
10-
11-
### Changed
12-
13-
- Updates to existing features.
14-
15-
### Deprecated
16-
17-
- Features or functionalities to be removed in future releases.
18-
19-
### Removed
20-
21-
- Features or functionalities that have been removed.
22-
23-
### Fixed
24-
25-
- Bug fixes.
26-
27-
### Security
28-
29-
- Security-related changes.
30-
31-
## [Version] - YYYY-MM-DD
32-
33-
### Added
34-
35-
- New feature or enhancement.
36-
37-
### Changed
38-
39-
- Updates to existing features.
40-
41-
### Deprecated
42-
43-
- Features or functionalities to be removed in future releases.
44-
45-
### Removed
46-
47-
- Features or functionalities that have been removed.
48-
49-
### Fixed
50-
51-
- Bug fixes.
52-
53-
### Security
54-
55-
- Security-related changes
9+
- React UI kit for managing and displaying in-app notification

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
## Overview
44

5-
The `@siren/react-inbox` sdk is a comprehensive and customizable React UI kit for displaying and managing notifications. This documentation provides comprehensive information on how to install, configure, and use the sdk effectively.
5+
The `@sirenapp/react-inbox` sdk is a comprehensive and customizable React UI kit for displaying and managing notifications. This documentation provides comprehensive information on how to install, configure, and use the sdk effectively.
66

77
## 1. Installation
88

99
You can install the react sdk from npm
1010

1111
```bash
12-
npm @siren/react-inbox
12+
npm @sirenapp/react-inbox
1313
```
1414
or from yarn
1515

1616
```bash
17-
yarn @siren/react-inbox
17+
yarn @sirenapp/react-inbox
1818
```
1919

2020
#### Prerequisites
@@ -26,7 +26,7 @@ yarn @siren/react-inbox
2626
Initialize the sdk with user token and recipient id. Wrap the provider around your App's root.
2727

2828
```js
29-
import { SirenProvider } from "@siren/react-inbox";
29+
import { SirenProvider } from "@sirenapp/react-inbox";
3030

3131
const config = {
3232
userToken: "your_user_token",
@@ -42,7 +42,7 @@ Once the provider is configured, next step is to configure the notification inbo
4242
Inbox is a paginated list view for displaying notifications.
4343

4444
```js
45-
import { SirenInbox } from '@siren/react-inbox';
45+
import { SirenInbox } from '@sirenapp/react-inbox';
4646

4747
<SirenInbox />
4848

@@ -192,7 +192,7 @@ Please note that the badgeStyle, window shadow and border props are only applica
192192
`useSiren` is a hook that provides utility functions for modifying notifications.
193193

194194
```js
195-
import { useSiren } from "@siren/react-inbox";
195+
import { useSiren } from "@sirenapp/react-inbox";
196196

197197
function MyComponent() {
198198
const {
@@ -259,7 +259,7 @@ Here's a basic example to help you get started
259259
```js
260260

261261
import React from 'react';
262-
import {SirenInbox,SirenProvider} from '@siren/react-inbox';
262+
import {SirenInbox,SirenProvider} from '@sirenapp/react-inbox';
263263

264264
function App(): React.JSX.Element {
265265

0 commit comments

Comments
 (0)