Add readme to javascript package (#106)

jupyter-server · Nov 29, 2022 · 6514a2a · 6514a2a
1 parent 3832ced
commit 6514a2a
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/javascript/README.md b/javascript/README.md
@@ -0,0 +1,8 @@
+# @jupyter/ydoc
+
+`@jupyter/ydoc` provides [Yjs](https://github.com/yjs/yjs)-based data structures for various
+documents used in the Jupyter ecosystem. Built-in documents include:
+- `YFile`: a generic text document.
+- `YNotebook`: a Jupyter notebook document.
+
+The API documentation is available [there](https://jupyter-ydoc.readthedocs.io/en/latest/api/index.html).