Skip to content

Commit 73bba2b

Browse files
committed
readme update
1 parent 85c6619 commit 73bba2b

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

Diff for: README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,26 @@
77
![GitHub Repo stars](https://img.shields.io/github/stars/Code-Forge-Net/Remix-Dev-Tools?style=social)
88
![npm](https://img.shields.io/npm/v/remix-development-tools?style=plastic)
99
![GitHub](https://img.shields.io/github/license/Code-Forge-Net/Remix-Dev-Tools?style=plastic)
10-
![npm](https://img.shields.io/npm/dy/remix-development-tools?style=plastic)
11-
![npm](https://img.shields.io/npm/dw/remix-development-tools?style=plastic)
12-
![GitHub top language](https://img.shields.io/github/languages/top/Code-Forge-Net/Remix-Dev-Tools?style=plastic)
10+
![npm](https://img.shields.io/npm/dy/remix-development-tools?style=plastic)
11+
![npm](https://img.shields.io/npm/dw/remix-development-tools?style=plastic)
12+
![GitHub top language](https://img.shields.io/github/languages/top/Code-Forge-Net/Remix-Dev-Tools?style=plastic)
1313

1414
Remix Development Tools is an open-source package designed to enhance your development workflow when working with Remix, a full-stack JavaScript framework for building web applications. This package provides a user-friendly interface consisting of three tabs, **Active Page**, **Terminal**, **Settings**, **Errors** and **Routes**, along with a side tab called **Timeline**. With Remix Development Tools, you can efficiently monitor and manage various aspects of your Remix projects, including page information, URL parameters, server responses, loader data, routes, and more. You can
1515
also track down hydration issues with the **Errors** tab and view your routes in a tree/list view with the **Routes** tab.
1616

17-
# Documentation
17+
# Documentation
1818

1919
Detailed documentation can be found here:
2020

2121
https://remix-development-tools.fly.dev/
2222

2323

24+
# Deprecation warning!
25+
26+
Huge news! The remix-development-tools will be turning into react-router-devtools once the stable release of react-router 7 is out! As you already might've heard remix is being merged into react-router, so naturally these devtools are going to be supporting react-router users rather than remix users!
27+
28+
We are looking forward to expanding the scope of our users to a much broader audience and helping even more projects. When it comes to remix-development-tools all the updates will be coming out regularly until the official release of react-router v7 where this package will be rebranded with the same feature set.
29+
2430
## Getting Started
2531

2632
1. Install the package via npm:
@@ -34,11 +40,11 @@ import { remixDevTools } from "remix-development-tools";
3440

3541
// Add it to your plugins array in vite.config.js
3642
export default defineConfig({
37-
plugins: [remixDevTools(), remix(), tsconfigPaths()],
43+
plugins: [remixDevTools(), remix(), tsconfigPaths()],
3844
});
3945
```
4046

41-
That's it, you're done!
47+
That's it, you're done!
4248

4349

4450
## Support

0 commit comments

Comments
 (0)