Skip to content

Commit adae9b7

Browse files
committed
Update README.md
1 parent 7af529e commit adae9b7

File tree

2 files changed

+22
-6
lines changed

2 files changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
<div align="center">
2+
<div align="center">
3+
<img src="./react-log-hook-screenshot.png" alt="React Log Hook Screenshot" width=400 />
4+
<br>
5+
<br>
6+
</div>
27
<img src="https://badgen.net/npm/v/react-log-hook" alt="NPM Version" />
38
<img src="https://badgen.net/npm/license/react-log-hook" alt="License" />
49
<img src="https://badgen.net/bundlephobia/minzip/react-log-hook" alt="minzipped size"/>
@@ -66,16 +71,27 @@ const App = () => {
6671

6772
## FAQ
6873

69-
Comming Soon!
74+
### Will it deep copy the value to make sure it will persist in the logs?
75+
76+
- 🎉 Yes, 🪵 **react-log-hook** deep copies the value to make sure it will not be changed in the logs later
77+
78+
### Do i need to install @types/react-log-hook as well?
79+
80+
- 💪 No, 🪵 **react-log-hook** comes with prebundled types
81+
82+
### Will it run in production evironment?
83+
84+
- ✅ By default 🪵 **react-log-hook** will run only in `dev` or `development` node evironments defined by `NODE_ENV`
7085

7186
## Roadmap
7287

73-
- [ ] Add previous state checking
74-
- [ ] Use object copy to persist in time
75-
- [ ] Use console groups to handle all the logs
88+
- [x] Add previous state checking
89+
- [x] Use object copy to persist in time
90+
- [x] Use console groups to handle all the logs
91+
- [x] Add dev environment support by default
92+
- [x] Polish the looks with component names, function calls, time etc
93+
- [ ] Add more customization options
7694
- [ ] Support SSR & Server components
77-
- [ ] Polish the looks with component names, function calls, time etc
78-
- [ ] TBD
7995

8096
## Contributing
8197

react-log-hook-screenshot.png

195 KB
Loading

0 commit comments

Comments
 (0)