Minor sprucing: (#47)

* Change package names
* Put README in published package
* Change Yjs to a peer dep (no impact on examples since peer deps
  are installed if necesasry).

README.md

@@ -1,25 +1,20 @@
-# `@rocicorp/reflect-yjs`
+# `reflect-yjs`
 
-This library enables storing and syncing Yjs documents via [Reflect](https://reflect.net/).
+This library enables collaborative text editing in [Reflect](https://reflect.net/) via [Yjs](https://yjs.dev/).
 
 Live demo at https://type.reflect.net/.
 
 ## Features
 
 - **Awareness**: A robust implementation of Yjs "awareness" is included. Awareness is correctly cleaned up in all cases including tab-close, tab/browser-crash, navigation, tab-switch, offline, etc.
 - **Multiple Documents**: A single Reflect room can host any number of Yjs documents efficiently.
-- **Chunking** (soon): Large Yjs documents are automatically broken down into smaller pieces for efficient incremental updates.
+- **Chunking**: Large Yjs documents are automatically broken down into smaller pieces for efficient incremental updates.
+- **Validation**: Easily run custom validation on the server-side to filter profanity, enforce max length, or any other constraint you need.
 - **Editor Integration Examples**: Contains practical examples for `codemirror-yjs`, `monaco-yjs`, `tiptap-yjs`.
 
 ## Getting Started
 
-### Installation
-
-To install `@rocicorp/reflect-yjs`, run the following command:
-
-```bash
-npm install @rocicorp/reflect-yjs@latest
-```
+See https://hello.reflect.net/how/text
 
 ### Running an Example
 

examples/codemirror/package.json

@@ -17,8 +17,7 @@
     "@codemirror/lang-javascript": "^6.2.1",
     "@rocicorp/eslint-config": "^0.5.1",
     "@rocicorp/prettier-config": "^0.2.0",
-    "@rocicorp/reflect-yjs": "0.0.1",
-    "@rocicorp/reflect": "^0.38.202312080119",
+    "@rocicorp/reflect": ">=0.38.202312080119 <=0.39.0",
     "@types/react-dom": "^18.2.17",
     "@types/react": "^18.2.38",
     "@vitejs/plugin-react": "^4.2.0",
@@ -27,6 +26,7 @@
     "react-codemirror2": "^7.3.0",
     "react-dom": "^18.2.0",
     "react": "^18.2.0",
+    "reflect-yjs": "0.0.1",
     "typescript": "^5.3.2",
     "vite": "^5.0.2",
     "y-codemirror": "^3.0.1"

examples/codemirror/src/index.tsx

@@ -8,11 +8,7 @@ import {CodemirrorBinding} from 'y-codemirror';
 import * as Y from 'yjs';
 import './index.css';
 import styles from './index.module.css';
-import {
-  Provider,
-  mutators,
-  mutators as yjsMutators,
-} from '@rocicorp/reflect-yjs';
+import {Provider, mutators, mutators as yjsMutators} from 'reflect-yjs';
 import {UserInfo, randUserInfo} from './user-info.js';
 
 const userID = nanoid();

examples/codemirror/src/reflect/index.ts

@@ -1,5 +1,5 @@
 import type {AuthHandler, ReflectServerOptions} from '@rocicorp/reflect/server';
-import {mutators as yjsMutators, Mutators} from '@rocicorp/reflect-yjs';
+import {mutators as yjsMutators, Mutators} from 'reflect-yjs';
 
 const authHandler: AuthHandler = (auth: string, _roomID: string) => {
   if (auth) {

examples/monaco/package.json

@@ -16,8 +16,7 @@
   "devDependencies": {
     "@rocicorp/eslint-config": "^0.5.1",
     "@rocicorp/prettier-config": "^0.2.0",
-    "@rocicorp/reflect": "^0.38.202312080119",
-    "@rocicorp/reflect-yjs": "0.0.1",
+    "@rocicorp/reflect": ">=0.38.202312080119 <=0.39.0",
     "@types/react": "^18.2.38",
     "@types/react-dom": "^18.2.17",
     "@vitejs/plugin-react": "^4.2.0",
@@ -27,6 +26,7 @@
     "nanoid": "^5.0.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
+    "reflect-yjs": "0.0.1",
     "typescript": "^5.3.2",
     "vite": "^5.0.2",
     "y-monaco": "^0.1.5"

examples/monaco/src/index.ts

@@ -1,4 +1,4 @@
-import {Provider, mutators as yjsMutators} from '@rocicorp/reflect-yjs';
+import {Provider, mutators as yjsMutators} from 'reflect-yjs';
 import {Reflect} from '@rocicorp/reflect/client';
 import * as monaco from 'monaco-editor';
 import editorWorker from 'monaco-editor/esm/vs/editor/editor.worker?worker';

examples/monaco/src/reflect/index.ts

@@ -1,4 +1,4 @@
-import {mutators as yjsMutators, updateYJS} from '@rocicorp/reflect-yjs';
+import {mutators as yjsMutators, updateYJS} from 'reflect-yjs';
 // @ts-expect-error "no ts support"
 import {regex} from 'badwords-list';
 

examples/tiptap/package.json

@@ -18,8 +18,7 @@
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@rocicorp/reflect": "^0.38.202312080119",
-    "@rocicorp/reflect-yjs": "0.0.1",
+    "@rocicorp/reflect": ">=0.38.202312080119 <=0.39.0",
     "@tiptap/core": "^2.0.4",
     "@tiptap/extension-collaboration": "^2.0.4",
     "@tiptap/extension-collaboration-cursor": "^2.0.4",
@@ -35,8 +34,8 @@
     "lexical": "^0.11.1",
     "nanoid": "^5.0.3",
     "next": "^13.5.4",
-    "typescript": "^5.3.2",
-    "yjs": "^13.6.10"
+    "reflect-yjs": "0.0.1",
+    "typescript": "^5.3.2"
   },
   "dependencies": {
     "@tiptap/extension-code-block-lowlight": "^2.1.13",

examples/tiptap/src/components/Footer.tsx

@@ -1,6 +1,6 @@
 "use client";
 import React, { useEffect, useState } from "react";
-import { Provider } from "@rocicorp/reflect-yjs";
+import { Provider } from "reflect-yjs";
 import { UserInfo } from "./TextEditor";
 
 export function Footer({

examples/tiptap/src/components/TextEditor.tsx

@@ -2,7 +2,7 @@
 import "./TextEditor.css";
 import React, { useState, useEffect } from "react";
 import * as Y from "yjs";
-import { Provider, mutators as yjsMutators } from "@rocicorp/reflect-yjs";
+import { Provider, mutators as yjsMutators } from "reflect-yjs";
 import { Reflect } from "@rocicorp/reflect/client";
 import { nanoid } from "nanoid";
 import { EditorContent, useEditor } from "@tiptap/react";

examples/tiptap/src/reflect/index.ts

@@ -2,7 +2,7 @@ import type {
   AuthHandler,
   ReflectServerOptions,
 } from "@rocicorp/reflect/server";
-import { mutators as yjsMutators, Mutators } from "@rocicorp/reflect-yjs";
+import { mutators as yjsMutators, Mutators } from "reflect-yjs";
 import { WriteTransaction } from "@rocicorp/reflect";
 
 const authHandler: AuthHandler = (auth: string, _roomID: string) => {

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "reflect-yjs",
+  "name": "@rocicorp/reflect-yjs",
   "version": "0.0.0",
   "private": true,
   "license": "Apache-2.0",