Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ianmacartney committed Dec 19, 2024
1 parent 9e3438a commit 05a0b0c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ alongside the rest of your app's data.

Just configure your editor features, add this component to your Convex backend,
and use the `useTiptapSync` React hook.
Read this [Stack post](https://stack.convex.dev/add-a-collaborative-document-editor-to-your-app) for more details.

This is a [Convex Component](https://convex.dev/components) that syncs a
[ProseMirror](https://prosemirror.net/) document between clients via a
[Tiptap](https://tiptap.dev/) extension.

[![Example of editing](https://i.vimeocdn.com/video/1963290904-61fca04b89d193f0462f33b686d6c177330ae5c45eef601af2a85903db697072-d_1080x720?r=pad)](https://vimeo.com/1040674822?badge=0&autopause=0)

Example usage, see [below](#usage) for more details:

```tsx
Expand Down

0 comments on commit 05a0b0c

Please sign in to comment.