@pluv/io 0.2.0 → 0.2.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/io@0.2.0 build /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.2.1 build /home/runner/work/pluv/pluv/packages/io
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,10 +8,10 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-ESM dist/index.mjs 26.79 KB
-ESM ⚡️ Build success in 117ms
 CJS dist/index.js 28.59 KB
-CJS ⚡️ Build success in 112ms
+CJS ⚡️ Build success in 95ms
+ESM dist/index.mjs 26.79 KB
+ESM ⚡️ Build success in 96ms
 DTS Build start
-DTS ⚡️ Build success in 2389ms
+DTS ⚡️ Build success in 2778ms
 DTS dist/index.d.ts 12.86 KB

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @pluv/io
 
+## 0.2.1
+
+### Patch Changes
+
+- b45d642: Fixed links on README
+- 203dfee: Updated README
+- Updated dependencies [b45d642]
+  - @pluv/crdt-yjs@0.1.2
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -39,7 +39,72 @@
 
 Pluv.IO allows you to build real-time collaborate features with a fully end-to-end type-safe api.
 
+### Why
+
+So you can do this:
+
+```tsx
+usePluvEvent("RECEIVE_MESSAGE", ({ data }) => {
+  setMessages([...messages, data.message]);
+});
+
+usePluvBroadcast({
+  type: "SEND_MESSAGE",
+  data: { message: "Hello world!" },
+});
+```
+
+And this:
+
+```tsx
+const [myCursor, updatePresence] = usePluvMyPresence((me) => me.presence.cursor);
+const cursors = usePluvOthers((others) => {
+  return others.map((other) => other.presence.cursor);
+});
+
+useEffect(() => {
+  const updateCursor = (e: MouseEvent) => {
+    updatePresence({ cursor: { x: e.pageX, y: e.pageY } });
+  };
+
+  window.addEventListener("mousemove", updateCursor);
+
+  return () => {
+    window.removeEventListener("mousemove", updateCursor);
+  };
+}, [updatePresence]);
+
+return (
+  <div>
+    <div style={{ top: myCursor?.y, left: myCursor?.x }} />
+    {cursors.map((cursor, i) => (
+      <div key={i} style={{ top: cursor?.y, left: cursor?.x }} />
+    ))}
+  </div>
+);
+```
+
+Also this:
+
+
+```tsx
+const [messages, sharedType] = usePluvStorage("messages");
+
+sharedType?.push(["Hello world!"]);
+
+return (
+  <div>
+    {messages?.map((message, i) => (
+      <div key={i}>{message}</div>
+    ))}
+  </div>
+);
+```
+
+And more. With great **E2E type-safety**, **intellisense** and the **[yjs](https://docs.yjs.dev/) ecosystem**.
+
 ### Features
+
 - ✅ Automatic type safety
 - ✅ Basic events
 - ✅ Rooms
@@ -56,6 +121,7 @@ Pluv.IO allows you to build real-time collaborate features with a fully end-to-e
 - ⬜ Studio (admin & developer panel)
 
 ### Runtimes
+
 - ✅ [Cloudflare Workers](https://workers.cloudflare.com/)
 - ✅ [Node.js](https://nodejs.org/)
   - ✅ **PubSubs**
@@ -67,6 +133,7 @@ Pluv.IO allows you to build real-time collaborate features with a fully end-to-e
     - ⬜ [Prisma](https://www.prisma.io/)
 
 ### Frontends
+
 - ✅ [React.js](https://beta.reactjs.org/)
 - ⬜ [Vue.js](https://vuejs.org/)
 - ⬜ [Svelte](https://svelte.dev/)
@@ -88,6 +155,7 @@ Before diving into documentation, check out usage instructions for your selected
 * [Authentication](https://github.com/pluv-io/pluv/blob/master/docs/authentication.md)
 * [CRDT Storage](https://github.com/pluv-io/pluv/blob/master/docs/crdt-storage.md)
 * [Creating Rooms](https://github.com/pluv-io/pluv/blob/master/docs/creating-rooms.md)
+* [`createIO` API](https://github.com/pluv-io/pluv/blob/master/docs/create-io-api.md)
 * [Custom Events](https://github.com/pluv-io/pluv/blob/master/docs/custom-events.md)
 * [Presence](https://github.com/pluv-io/pluv/blob/master/docs/presence.md)
 * [PubSubs and Persistance](https://github.com/pluv-io/pluv/blob/master/docs/pubsubs-and-persistance.md)
@@ -95,13 +163,13 @@ Before diving into documentation, check out usage instructions for your selected
 
 ## Related
 
-- [@pluv/client](https://github.com/pluv-io/pluv/tree/master/packages/client) - Framework agnostic client
-- [@pluv/crdt-yjs](https://github.com/pluv-io/pluv/tree/master/packages/crdt-yjs) - Yjs for Pluv.IO
-- [@pluv/persistance-redis](https://github.com/pluv-io/pluv/tree/master/packages/persistance-redis) - Persistance for storage on distributed systems (Node.js only)
-- [@pluv/platform-cloudflare](https://github.com/pluv-io/pluv/tree/master/packages/platform-cloudflare) - Adapter to run @pluv/io on Cloudflare Workers
-- [@pluv/platform-node](https://github.com/pluv-io/pluv/tree/master/packages/platform-node) - Adapter to run @pluv/io on Node.js
-- [@pluv/pubsub-redis](https://github.com/pluv-io/pluv/tree/master/packages/pubsub-redis) - PubSub for rooms across distributed systems
-- [@pluv/react](https://github.com/pluv-io/pluv/tree/master/packages/react) - Integrate @pluv/client with React.js
+- [@pluv/client](https://www.npmjs.com/package/@pluv/client) - Framework agnostic client
+- [@pluv/crdt-yjs](https://www.npmjs.com/package/@pluv/crdt-yjs) - Yjs for Pluv.IO
+- [@pluv/persistance-redis](https://www.npmjs.com/package/@pluv/persistance-redis) - Persistance for storage on distributed systems (Node.js only)
+- [@pluv/platform-cloudflare](https://www.npmjs.com/package/@pluv/platform-cloudflare) - Adapter to run @pluv/io on Cloudflare Workers
+- [@pluv/platform-node](https://www.npmjs.com/package/@pluv/platform-node) - Adapter to run @pluv/io on Node.js
+- [@pluv/pubsub-redis](https://www.npmjs.com/package/@pluv/pubsub-redis) - PubSub for rooms across distributed systems
+- [@pluv/react](https://www.npmjs.com/package/@pluv/react) - Integrate @pluv/client with React.js
 
 ## Credits
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/io",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "@pluv/io server-side websocket manager",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "@panva/hkdf": "^1.0.2",
-    "@pluv/crdt-yjs": "^0.1.1",
+    "@pluv/crdt-yjs": "^0.1.2",
     "@pluv/types": "^0.1.1",
     "chalk": "^4.1.2",
     "jose": "^4.11.2",