Skip to content

Commit d1437b3

Browse files
📝 update readme
1 parent 56b6046 commit d1437b3

File tree

2 files changed

+25
-9
lines changed

2 files changed

+25
-9
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
1-
# React Confetti Boom
1+
# React Confetti Boom 🎉
22

3-
React Confetti Boom is a lightweight, customizable confetti animation component for React applications. Add a fun and engaging confetti effect to your app with just a few lines of code.
3+
![NPM](https://img.shields.io/npm/v/react-confetti-boom.svg)
4+
![NPM Downloads](https://img.shields.io/npm/dt/react-confetti-boom.svg)
5+
![License](https://img.shields.io/npm/l/react-confetti-boom)
6+
![Size](https://img.shields.io/bundlephobia/min/react-confetti-boom)
47

5-
[![NPM](https://img.shields.io/npm/v/react-confetti-boom.svg)](https://www.npmjs.com/package/react-confetti-boom)
8+
React Confetti Boom 🎉 is a lightweight and customizable confetti animation component for React applications. Enhance user experience by adding a fun and engaging confetti effect to your app with just a few lines of code.
69

7-
<div align="center" style="background-color: rgb(0,0,0)">
8-
<img src="docs/preview.gif" />
9-
</div>
10+
11+
<p align="center">
12+
<img src="docs/preview.gif" alt="React Confetti Boom preview" />
13+
</p>
14+
15+
## Table of Contents
16+
17+
- [Installation](#installation)
18+
- [Usage](#usage)
19+
- [Demo](#demo)
20+
- [Props](#props)
21+
- [Example](#example)
22+
- [License](#license)
1023

1124
## Installation
1225

26+
To install React Confetti Boom, run the following command:
27+
1328
```bash
1429
npm install react-confetti-boom
1530
```
@@ -34,7 +49,7 @@ function MyApp() {
3449
export default MyApp;
3550
```
3651

37-
## Demo
52+
## Live Demo
3853

3954
You can check out the live demo of `react-confetti-boom` in action on the following page: [https://almond-bongbong.github.io/react-confetti-boom/](https://almond-bongbong.github.io/react-confetti-boom/)
4055

@@ -87,4 +102,5 @@ This example will render a confetti animation with 50 particles starting at 10%
87102

88103
## License
89104

90-
MIT
105+
This project is licensed under the terms of the MIT License.
106+

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-confetti-boom",
3-
"version": "0.0.3",
3+
"version": "0.0.4",
44
"description": "A customizable React confetti explosion component for celebrations and special events",
55
"author": "almond-bongbong <bal.dongdongdong@gmail.com>",
66
"homepage": "https://github.com/almond-bongbong/react-confetti-boom",

0 commit comments

Comments
 (0)