Skip to content

Commit e019e90

Browse files
authored
Update README.md
1 parent 3c7aab4 commit e019e90

File tree

1 file changed

+28
-18
lines changed

1 file changed

+28
-18
lines changed

README.md

+28-18
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
# React Native Custom Timer Notification 🔔
22

3-
A powerful, flexible notification library for React Native Android that enables custom timer-based notifications with advanced customization options.
3+
A powerful, flexible notification library for React Native Android that enables custom timer and GIF-based notifications with advanced customization options.
44

5-
## 🚀 Key Features
5+
Now v0.9.1 supports Gif in Android 14+
6+
<p align="center">
7+
<img width="50%" src="https://github.com/user-attachments/assets/5578e1aa-ac4c-458e-a661-c334e6bf8741">
8+
</p>
9+
10+
## Key Features
611

712
- **Customizable Timer Notifications**: Create dynamic, time-based notifications
813
- **Animated GIF Support**: Enhance notifications with animated graphics
914
- **Fully Customizable Notification Layouts**: Design unique notification experiences
1015

1116

12-
## 📦 Installation
17+
## Installation
1318

1419
```bash
1520
npm install react-native-custom-timer-notification
@@ -36,14 +41,10 @@ Inside the `<application>` tag, add:
3641
<service android:name="com.reactnativecustomtimernotification.ForegroundService"/>
3742
```
3843

39-
## 🎯 Usage Scenarios
44+
## Usage Scenarios
4045

4146
### Basic Timer Notification
4247

43-
<p align="center">
44-
<img width="80%" src="https://user-images.githubusercontent.com/58332892/166133982-effe321c-a0fd-4315-bb29-cc7ee29d0bd4.gif">
45-
</p>
46-
4748
```javascript
4849
import { TimerNotification } from "react-native-custom-timer-notification";
4950

@@ -55,12 +56,8 @@ TimerNotification({
5556
payload: "meeting-123"
5657
});
5758
```
58-
5959
### Animated Notification with GIF
6060

61-
<p align="center">
62-
<img width="50%" src="https://github.com/user-attachments/assets/cea88228-602a-42df-8326-569fd0a03cf1">
63-
</p>
6461

6562
```javascript
6663
CustomTimerNotification.TimerNotification({
@@ -83,7 +80,7 @@ CustomTimerNotification.TimerNotification({
8380
| gifUrl | string | No | URL to GIF animation |
8481
| payload | string | No | Custom data payload |
8582

86-
## 🎨 Full Custom Notification
83+
## Full Custom Notification
8784

8885
Create fully customized notifications with detailed configurations:
8986
<p align="center">
@@ -110,14 +107,24 @@ CustomNotification({
110107
]
111108
});
112109
```
113-
#### ViewOptions
110+
111+
#### Options
112+
| Property | Description |
113+
| --- | --- |
114+
| `eventData` | sent data will be received when clicked or canceled |
115+
| `title` |Title of the notification|
116+
| `body` |Body of the notification |
117+
| `id` |unique number|
118+
| `View` |View that needs to be added (Array)|
119+
120+
#### View Options
114121

115122
| Property | Description |
116123
| --- | --- |
117124
| `name` | text that needs to be displayed |
118125
| `size` |Size of text|
119-
| `type` |Type of view (Text,Image, Cronometer) |
120-
| `bold` |Font (NORMAL,BOLD,ITALIC,BOLD_ITALIC)|
126+
| `type` |Type of view (Text, Image, Cronometer) |
127+
| `bold` |Font (NORMAL, BOLD,ITALIC, BOLD_ITALIC)|
121128
| `uri` |Image in base64|
122129
| `PaddingLeft` |Left Padding|
123130
| `PaddingTop` |PaddingTop|
@@ -131,9 +138,12 @@ CustomNotification({
131138

132139
See the contributing guide to learn how to contribute to the repository and the development workflow.
133140

141+
## 📄 License
142+
143+
MIT Licensed. See LICENSE file for details.
134144

135-
## License
145+
## 🔍 Keywords
136146

137-
MIT
147+
react-native, notifications, timer-notifications, gif-notifications, android-notifications, custom-notifications, countdown-timer, animated-notifications, react-native-notifications, mobile-notifications, push-notifications, notification-system, react-native-android, notification-timer, countdown-notifications, custom-notification-layout
138148

139149

0 commit comments

Comments
 (0)