Merge branch 'dev' of github.com:KeyValueSoftwareSystems/siren-react-native-inbox into dev

Author: abhay-keyvalue

CHANGELOG.md

@@ -2,55 +2,8 @@
 
 All notable changes to this project will be documented in this file.
 
-## [Unreleased]
+## [1.0.0] - 2024-03-26
 
 ### Added
 
-- New feature or enhancement.
-
-### Changed
-
-- Updates to existing features.
-
-### Deprecated
-
-- Features or functionalities to be removed in future releases.
-
-### Removed
-
-- Features or functionalities that have been removed.
-
-### Fixed
-
-- Bug fixes.
-
-### Security
-
-- Security-related changes.
-
-## [Version] - YYYY-MM-DD
-
-### Added
-
-- New feature or enhancement.
-
-### Changed
-
-- Updates to existing features.
-
-### Deprecated
-
-- Features or functionalities to be removed in future releases.
-
-### Removed
-
-- Features or functionalities that have been removed.
-
-### Fixed
-
-- Bug fixes.
-
-### Security
-
-- Security-related changes
-
+- React native UI kit for managing and displaying in-app notification

README.md

@@ -2,27 +2,27 @@
 
 ## Overview
 
-The `@siren/react-native-inbox` sdk is a comprehensive and customizable React Native UI kit for displaying and managing notifications. This documentation provides comprehensive information on how to install, configure, and use the sdk effectively.
+The `@sirenapp/react-native-inbox` sdk is a comprehensive and customizable React Native UI kit for displaying and managing notifications. This documentation provides comprehensive information on how to install, configure, and use the sdk effectively.
 
 ## 1. Installation
 
 You can install the react sdk from npm 
 
 ```bash
-npm @siren/react-native-inbox
+npm @sirenapp/react-native-inbox
 ```
 or from yarn
 
 ```bash
-yarn @siren/react-native-inbox
+yarn @sirenapp/react-native-inbox
 ```
 
 ## 2. Configuration
 ### 2.1 Initialization
 Initialize the sdk with user token and recipient id. Wrap the provider around your App's root.
 
 ```js
-import { SirenProvider } from '@siren/react-native-inbox';
+import { SirenProvider } from '@sirenapp/react-native-inbox';
 
 const config = {
   userToken: 'your_user_token',
@@ -39,7 +39,7 @@ Once the provider is configured, next step is to configure the notification icon
 
 This component consists of a notification icon along with a badge to display the number of unviewed notifications
 ```js
-import { SirenInboxIcon } from '@siren/react-native-inbox';
+import { SirenInboxIcon } from '@sirenapp/react-native-inbox';
 
  <SirenInboxIcon />
 
@@ -98,7 +98,7 @@ Here are the custom style options for the notification icon:
 Inbox is a paginated list view for displaying notifications.
 
 ```js
-import { SirenInbox } from '@siren/react-native-inbox';
+import { SirenInbox } from '@sirenapp/react-native-inbox';
 
 <SirenInbox />
 
@@ -222,7 +222,7 @@ Here are the custom style options for the notification inbox:
 `useSiren` is a hook that provides utility functions for modifying notifications.
 
 ```js
-import { useSiren } from '@siren/react-native-inbox';
+import { useSiren } from '@sirenapp/react-native-inbox';
 
 function MyComponent() {
   const { markAsRead, deleteNotification } = useSiren();
@@ -268,7 +268,7 @@ Here's a basic example to help you get started
 
 import React from 'react';
 import {SafeAreaView} from 'react-native';
-import {SirenInbox,SirenInboxIcon,SirenProvider} from '@siren/react-native-inbox';
+import {SirenInbox,SirenInboxIcon,SirenProvider} from '@sirenapp/react-native-inbox';
 
 function App(): React.JSX.Element {
 

example/App.tsx

@@ -1,5 +1,5 @@
 import React from 'react';
-import { SirenProvider } from '@siren/react-native-inbox';
+import { SirenProvider } from '@sirenapp/react-native-inbox';
 import { NavigationContainer } from '@react-navigation/native';
 import { createNativeStackNavigator } from '@react-navigation/native-stack';
 
@@ -24,10 +24,10 @@ function MyStack() {
 }
 
 function App(): React.JSX.Element {
-  const [config, setConfig] = React.useState({
-    userToken: '227047349b3044fbac7c24fdf5537c44',
-    recipientId: '551cd601-65b3-41b2-bbce-bbd15908992f'
-  });
+  const config = {
+    userToken: 'YOUR_USER_TOKEN',
+    recipientId: 'YOUR_RECIPIENT_ID',
+  };
 
   return (
     <NavigationContainer>