Skip to content

Commit

Permalink
chore: updated readme to remove text caveat
Browse files Browse the repository at this point in the history
Also updated presence caveat with a reference to y-react.
  • Loading branch information
joebobmiles committed Mar 14, 2023
1 parent 8f60467 commit 54ec96b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,12 @@ render(

## Caveats

1. Currently the Y Text shared type is not supported. This means that strings
in the store do not benefit from the conflict-resolution performed by Yjs.
1. The Yjs awareness protocol is not supported. At the moment, it is unclear
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
awareness without the middleware.

# License

Expand Down

0 comments on commit 54ec96b

Please sign in to comment.