@liveblocks/yjs/README.md

Integrate your existing or new Yjs documents with Liveblocks.

<p align="center">
  <a href="https://liveblocks.io#gh-light-mode-only">
    <img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-light.svg" alt="Liveblocks" />
  </a>
  <a href="https://liveblocks.io#gh-dark-mode-only">
    <img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-dark.svg" alt="Liveblocks" />
  </a>
</p>

# `@liveblocks/yjs`

`@liveblocks/yjs` is a Yjs provider to integrate
[Yjs](https://github.com/yjs/yjs) applications with Liveblocks—a platform to
build, host, and scale collaborative applications with zero configuration, no
maintenance required.

## Installation

```
npm install @liveblocks/client @liveblocks/yjs
```

## Documentation

Read the
[documentation](https://liveblocks.io/docs/api-reference/liveblocks-yjs) for
guides and API references.

## Examples

Explore our [collaborative examples](https://liveblocks.io/examples) to help you
get started.

> All examples are open-source and live in this repository, within
> [`/examples`](../../examples).

## Releases

See the [latest changes](https://github.com/liveblocks/liveblocks/releases) or
learn more about
[upcoming releases](https://github.com/liveblocks/liveblocks/milestones).

## Community

- [Discord](https://liveblocks.io/discord) - To get involved with the Liveblocks
  community, ask questions and share tips.
- [X](https://x.com/liveblocks) - To receive updates, announcements, blog posts,
  and general Liveblocks tips.

## License

Licensed under the Apache License 2.0, Copyright © 2021-present
[Liveblocks](https://liveblocks.io).

See [LICENSE](../../LICENSE) for more information.