From ac52f2dc95e88e68d7fd29f258cd9b1e09f01cee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Stabell?= Date: Thu, 27 Jun 2024 13:27:48 -0700 Subject: [PATCH 1/3] Update readme.md - fix link - seems that immer isn't supported --- readme.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index a0f3406..f2562a6 100644 --- a/readme.md +++ b/readme.md @@ -13,7 +13,8 @@ through special hooks. Because this solution is simply a middleware, it can also work anywhere Zustand can be used. The vanilla Zustand `create()` function handles middleware exactly the same as the React version. And not only that, but it can be composed with -other middleware, such as Immer or Redux! +other middleware, such as Redux! +([Immer doesn't work](https://github.com/joebobmiles/zustand-middleware-yjs/issues/53)) ## Example @@ -80,7 +81,7 @@ render( if the library is able to support Yjs protocols. This means that, for now, support for the awareness protocol is not planned. * This does not mean you cannot use awareness in your projects - see the - sister project [y-react](joebobmiles/y-react) for an example of using + sister project [y-react](https://github.com/joebobmiles/y-react) for an example of using awareness without the middleware. # License @@ -105,4 +106,4 @@ This library is licensed under the MIT license: > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -> SOFTWARE. \ No newline at end of file +> SOFTWARE. From 4e8349ffd77f83855ee425063fb820db5bfe63c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Stabell?= Date: Thu, 27 Jun 2024 13:33:41 -0700 Subject: [PATCH 2/3] Update readme.md - add link to zustand-yjs --- readme.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index f2562a6..69426e0 100644 --- a/readme.md +++ b/readme.md @@ -5,7 +5,8 @@ with modern state management libraries in React. This middleware for Zustand solves that problem by allowing a Zustand store to be turned into a CRDT, with the store's state replicated to all peers. -This differs from the other Yjs and Zustand solution, `zustand-yjs` by allowing +This differs from the other Yjs and Zustand solution, +[`zustand-yjs`](https://github.com/tandem-pt/zustand-yjs), by allowing any Zustand store be turned into a CRDT. This contrasts with `zustand-yjs`'s solution, which uses a Zustand store to collect shared types and access them through special hooks. @@ -13,8 +14,7 @@ through special hooks. Because this solution is simply a middleware, it can also work anywhere Zustand can be used. The vanilla Zustand `create()` function handles middleware exactly the same as the React version. And not only that, but it can be composed with -other middleware, such as Redux! -([Immer doesn't work](https://github.com/joebobmiles/zustand-middleware-yjs/issues/53)) +other middleware, such as Immer or Redux! ## Example @@ -81,7 +81,7 @@ render( if the library is able to support Yjs protocols. This means that, for now, support for the awareness protocol is not planned. * This does not mean you cannot use awareness in your projects - see the - sister project [y-react](https://github.com/joebobmiles/y-react) for an example of using + sister project [y-react](joebobmiles/y-react) for an example of using awareness without the middleware. # License From 6aaebb7f35df3299cc0b1d3923e2b2be9e5468d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Stabell?= Date: Thu, 27 Jun 2024 13:37:02 -0700 Subject: [PATCH 3/3] Update readme.md --- readme.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 69426e0..4af2499 100644 --- a/readme.md +++ b/readme.md @@ -14,7 +14,8 @@ through special hooks. Because this solution is simply a middleware, it can also work anywhere Zustand can be used. The vanilla Zustand `create()` function handles middleware exactly the same as the React version. And not only that, but it can be composed with -other middleware, such as Immer or Redux! +other middleware, such as Redux! +([Immer doesn't work](https://github.com/joebobmiles/zustand-middleware-yjs/issues/53)) ## Example @@ -81,7 +82,7 @@ render( if the library is able to support Yjs protocols. This means that, for now, support for the awareness protocol is not planned. * This does not mean you cannot use awareness in your projects - see the - sister project [y-react](joebobmiles/y-react) for an example of using + sister project [y-react](https://github.com/joebobmiles/y-react) for an example of using awareness without the middleware. # License