Skip to content

Commit d6bbb9e

Browse files
Update README.md
1 parent bf8b6c5 commit d6bbb9e

File tree

1 file changed

+34
-18
lines changed

1 file changed

+34
-18
lines changed

README.md

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,42 @@
1+
2+
13
# 🛡️ React Smart Error Boundary
24

3-
A lightweight and customizable error boundary component for React applications.
5+
> **⚠️ This package is currently under development and not yet ready for production use.**
6+
> Please ⭐️ the repository and check back soon for updates!
7+
8+
---
9+
10+
A lightweight and customizable error boundary component for React applications.
411
Gracefully catch and display runtime errors in your UI — with zero configuration and full flexibility.
512

613
---
714

8-
## 🚀 Installation
15+
## 🚧 Status: Under Construction
16+
17+
We're actively working to finalize and publish this package. Expect improvements, breaking changes, and feature additions in upcoming releases.
18+
19+
If you'd like to contribute or follow progress:
20+
21+
* [📂 Repository](https://github.com/AkshayPanchivala/react-smart-error-boundary)
22+
* [🐛 Report Issues](https://github.com/AkshayPanchivala/react-smart-error-boundary/issues)
23+
* ⭐ Star the repo to stay updated!
24+
25+
---
26+
27+
## 🚀 Planned Installation
928

10-
Install using npm or yarn:
29+
Coming soon via npm or yarn:
1130

1231
```bash
1332
npm install react-smart-error-boundary
1433
# or
1534
yarn add react-smart-error-boundary
16-
````
35+
```
1736

1837
---
1938

20-
## Usage
39+
## 📊 Planned Usage
2140

2241
```tsx
2342
import { ErrorBoundary } from 'react-smart-error-boundary';
@@ -43,7 +62,7 @@ function App() {
4362

4463
---
4564

46-
## 🧩 Props
65+
## 🧩 Props (Planned)
4766

4867
| Prop | Type | Description |
4968
| ---------- | ------------------------------------------------------------------- | -------------------------------------------- |
@@ -53,19 +72,13 @@ function App() {
5372

5473
---
5574

56-
## ✨ Features
75+
## Planned Features
5776

58-
* ⚙️ Works with React 17 & 18
77+
* ⚙️ Support for React 17 & 18
5978
* 🎨 Fully customizable fallback UI
60-
* 🧠 Supports both static and dynamic fallback rendering
79+
* 🧠 Supports static and dynamic fallback rendering
6180
* 💡 Written in TypeScript
62-
* 💼 Perfect for production-ready React apps
63-
64-
---
65-
66-
## 📦 NPM
67-
68-
[![NPM](https://img.shields.io/npm/v/react-smart-error-boundary.svg)](https://www.npmjs.com/package/react-smart-error-boundary)
81+
* 💼 Production-ready best practices
6982

7083
---
7184

@@ -75,10 +88,13 @@ MIT © [Akshay Panchivala](https://github.com/AkshayPanchivala)
7588

7689
---
7790

78-
## 🛠️ Issues & Contributions
91+
## ❤️ Contribution
7992

80-
Feel free to [open an issue](https://github.com/AkshayPanchivala/react-smart-error-boundary/issues) or submit a PR.
93+
We welcome contributions once development stabilizes.
94+
Feel free to [open issues](https://github.com/AkshayPanchivala/react-smart-error-boundary/issues) or submit a PR in the future.
8195

8296
---
8397

8498
Made with ❤️ by [Akshay Panchivala](https://github.com/AkshayPanchivala)
99+
100+

0 commit comments

Comments
 (0)