docs: update readme with package links

valtiojs · Jan 5, 2024 · d436883 · d436883
1 parent 42bb3e9
commit d436883
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,6 +4,12 @@ valtio utility for creating a proxy state with history tracking
 
 https://valtio.pmnd.rs/docs/api/utils/proxyWithHistory
 
+### Main Packages
+
+| Name           | Info                                                                                                                                                |
+| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| valtio-history | [code](packages/history-utility) <br/> <br/> [![npm version](https://badge.fury.io/js/valtio-history.svg)](https://badge.fury.io/js/valtio-history) |
+
 ---
 
 ## Getting Started

diff --git a/packages/history-utility/README.md b/packages/history-utility/README.md
@@ -12,7 +12,7 @@ https://valtio.pmnd.rs/docs/api/utils/proxyWithHistory
 
 ```tsx
 // replace the following line
-// import { proxyWithHistory } from '`valtio/utils';
+// import { proxyWithHistory } from 'valtio/utils';
 
 import { proxyWithHistory } from 'valtio-history';
 import { useSnapshot } from 'valtio';