Skip to content

Commit 6514a2a

Browse files
authored
Add readme to javascript package (#106)
1 parent 3832ced commit 6514a2a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

javascript/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# @jupyter/ydoc
2+
3+
`@jupyter/ydoc` provides [Yjs](https://github.com/yjs/yjs)-based data structures for various
4+
documents used in the Jupyter ecosystem. Built-in documents include:
5+
- `YFile`: a generic text document.
6+
- `YNotebook`: a Jupyter notebook document.
7+
8+
The API documentation is available [there](https://jupyter-ydoc.readthedocs.io/en/latest/api/index.html).

0 commit comments

Comments
 (0)