@pluv/io 5.0.1 → 5.0.3

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <a href="https://pluv.io/docs/introduction">
-    <img src="https://github.com/pluv-io/pluv/blob/master/assets/pluv-icon-192x192.png?raw=true" alt="Pluv.IO" width="156" style="border-radius:16px" />
+    <img src="https://github.com/pluv-io/pluv/blob/main/assets/pluv-icon-192x192.png?raw=true" alt="Pluv.IO" width="156" style="border-radius:16px" />
   </a>
 </div>
 
@@ -11,7 +11,7 @@
   <a href="https://www.npmjs.com/package/@pluv/io">
     <img src="https://img.shields.io/npm/v/@pluv/io" alt="npm @pluv/io" />
   </a>
-  <a href="https://github.com/pluv-io/pluv/blob/master/LICENSE">
+  <a href="https://github.com/pluv-io/pluv/blob/main/LICENSE">
     <img alt="GitHub" src="https://img.shields.io/github/license/pluv-io/pluv" alt="License MIT" />
   </a>
   <a href="https://commitizen.github.io/cz-cli/">
@@ -39,25 +39,25 @@ Create your pluv.io backend
 ```ts
 // backend
 const io = createIO(
-  platformNode({
-    context: () => ({ db }),
-    crdt: yjs,
-  })
+    platformNode({
+        context: () => ({ db }),
+        crdt: yjs,
+    }),
 );
 
 export const ioServer = io.server({
-  getInitialStorage: async ({ context: { db }, room }) => {
-    return await db.room
-      .findUnique({ where: { id: room } })
-      .then((result) => result?.encodedState ?? null);
-  },
-  router: io.router({
-    sendGreeting: io.procedure
-      .input(z.object({ message: z.string() }))
-      .broadcast(({ message }) => ({
-        receiveGreeting: { message }
-      }))
-  })
+    getInitialStorage: async ({ context: { db }, room }) => {
+        return await db.room
+            .findUnique({ where: { id: room } })
+            .then((result) => result?.encodedState ?? null);
+    },
+    router: io.router({
+        sendGreeting: io.procedure
+            .input(z.object({ message: z.string() }))
+            .broadcast(({ message }) => ({
+                receiveGreeting: { message },
+            })),
+    }),
 });
 ```
 
@@ -67,29 +67,25 @@ Create your frontend client with your backend types
 // frontend
 const types = infer((i) => ({ io: i<typeof ioServer> }));
 const io = createClient({
-  types,
-  initialStorage: yjs.doc((t) => ({
-    messages: t.array<string>("messages"),
-  })),
-  presence: z.object({
-    selectionId: z.string().nullable()
-  })
+    types,
+    initialStorage: yjs.doc((t) => ({
+        messages: t.array<string>("messages"),
+    })),
+    presence: z.object({
+        selectionId: z.string().nullable(),
+    }),
 });
 
-const {
-  event,
-  useBroadcast,
-  useMyPresence,
-  useOthers,
-  useStorage
-} = createBundle(io);
+const { event, useBroadcast, useMyPresence, useOthers, useStorage } = createBundle(io);
 ```
 
 Use powerful primitives to build realtime features
 
 ```tsx
 // react
-event.receiveGreeting.useEvent(({ data }) => { /* ... */});
+event.receiveGreeting.useEvent(({ data }) => {
+    /* ... */
+});
 //                                ^? const data: { message: string }
 
 const broadcast = useBroadcast();
@@ -98,20 +94,20 @@ broadcast.sendGreeting({ message: "hello world" });
 //        ^? const sendGreeting: (data: { message: string }) => void
 
 const [mySelection, update] = useMyPresence((presence) => {
-//     ^? const mySelection: string | null
-  return presence.selectionId;
+    //     ^? const mySelection: string | null
+    return presence.selectionId;
 });
 
 const others = useOthers((others) => {
-//    ^? const others = string[]
-  return others.map((other) => other.presence.selectionId);
+    //    ^? const others = string[]
+    return others.map((other) => other.presence.selectionId);
 });
 
 const [
-  messages,
-// ^? const messages: string[] | null
-  sharedType
-// ^? YArray<string> | null
+    messages,
+    // ^? const messages: string[] | null
+    sharedType,
+    // ^? YArray<string> | null
 ] = useStorage("messages");
 ```
 
@@ -196,4 +192,4 @@ This software uses the following open source tooling and libraries:
 
 ## License
 
-[MIT](https://github.com/pluv-io/pluv/blob/master/LICENSE)
+[MIT](https://github.com/pluv-io/pluv/blob/main/LICENSE)