@pluv/io 0.3.4 → 0.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/.turbo/turbo-build.log +5 -5
  2. package/CHANGELOG.md +14 -0
  3. package/README.md +4 -62
  4. package/package.json +2 -2
package/.turbo/turbo-build.log CHANGED
@@ -1,5 +1,5 @@
1
1
 
2
- > @pluv/io@0.3.4 build /home/runner/work/pluv/pluv/packages/io
2
+ > @pluv/io@0.3.6 build /home/runner/work/pluv/pluv/packages/io
3
3
  > tsup src/index.ts --format esm,cjs --dts
4
4
 
5
5
  CLI Building entry: src/index.ts
@@ -8,10 +8,10 @@
8
8
  CLI Target: es6
9
9
  ESM Build start
10
10
  CJS Build start
11
- CJS dist/index.js 29.25 KB
12
- CJS ⚡️ Build success in 80ms
13
11
  ESM dist/index.mjs 27.19 KB
14
- ESM ⚡️ Build success in 87ms
12
+ ESM ⚡️ Build success in 112ms
13
+ CJS dist/index.js 29.25 KB
14
+ CJS ⚡️ Build success in 113ms
15
15
  DTS Build start
16
- DTS ⚡️ Build success in 2666ms
16
+ DTS ⚡️ Build success in 2971ms
17
17
  DTS dist/index.d.ts 12.73 KB
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @pluv/io
2
2
 
3
+ ## 0.3.6
4
+
5
+ ### Patch Changes
6
+
7
+ - a7e2980: deleted links to docs that were removed
8
+
9
+ ## 0.3.5
10
+
11
+ ### Patch Changes
12
+
13
+ - 78fd644: updated readmes with links to the documentation website
14
+ - Updated dependencies [78fd644]
15
+ - @pluv/crdt-yjs@0.3.6
16
+
3
17
  ## 0.3.4
4
18
 
5
19
  ### Patch Changes
package/README.md CHANGED
@@ -22,7 +22,6 @@
22
22
  <a href="https://commitizen.github.io/cz-cli/">
23
23
  <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" />
24
24
  </a>
25
- <img src="https://img.shields.io/badge/website-coming%20soon!-blue" alt="Website coming soon!" />
26
25
  </p>
27
26
 
28
27
  <p align="center">
@@ -48,6 +47,8 @@
48
47
 
49
48
  Pluv.IO allows you to build real-time collaborative features with a fully end-to-end type-safe api.
50
49
 
50
+ **👉 See full documentation on [pluv.io](https://pluv.io/docs/introduction). 👈**
51
+
51
52
  ### Why?
52
53
 
53
54
  So you can do this:
@@ -62,53 +63,6 @@ usePluvEvent("RECEIVE_MESSAGE", ({ data }) => {
62
63
  broadcast("SEND_MESSAGE", { message: "Hello world!" });
63
64
  ```
64
65
 
65
- And this:
66
-
67
- ```tsx
68
- const [myCursor, updatePresence] = usePluvMyPresence((me) => me.cursor);
69
- const cursors = usePluvOthers((others) => {
70
- return others.map((other) => other.presence.cursor);
71
- });
72
-
73
- useEffect(() => {
74
- const updateCursor = (e: MouseEvent) => {
75
- updatePresence({ cursor: { x: e.pageX, y: e.pageY } });
76
- };
77
-
78
- window.addEventListener("mousemove", updateCursor);
79
-
80
- return () => {
81
- window.removeEventListener("mousemove", updateCursor);
82
- };
83
- }, [updatePresence]);
84
-
85
- return (
86
- <div>
87
- <div style={{ top: myCursor?.y, left: myCursor?.x }} />
88
- {cursors.map((cursor, i) => (
89
- <div key={i} style={{ top: cursor?.y, left: cursor?.x }} />
90
- ))}
91
- </div>
92
- );
93
- ```
94
-
95
- Also this:
96
-
97
-
98
- ```tsx
99
- const [messages, sharedType] = usePluvStorage("messages");
100
-
101
- sharedType?.push(["Hello world!"]);
102
-
103
- return (
104
- <div>
105
- {messages?.map((message, i) => (
106
- <div key={i}>{message}</div>
107
- ))}
108
- </div>
109
- );
110
- ```
111
-
112
66
  And more. With **E2E type-safety**, **great intellisense** and the **[yjs](https://docs.yjs.dev/) ecosystem**.
113
67
 
114
68
  ### Features
@@ -153,21 +107,9 @@ Before diving into documentation, check out usage instructions for your selected
153
107
  > **Note:**
154
108
  > `@pluv/io`, `@pluv/client`, `@pluv/crdt-yjs` and `@pluv/react` all require [yjs](https://docs.yjs.dev/) as a peer dependency.
155
109
 
156
- ### Platforms
157
-
158
- * [Cloudflare](https://github.com/pluv-io/pluv/blob/master/docs/cloudflare-support.md)
159
- * [Node.js](https://github.com/pluv-io/pluv/blob/master/docs/nodejs-support.md)
160
-
161
110
  ### Documentation
162
111
 
163
- * [Authentication](https://github.com/pluv-io/pluv/blob/master/docs/authentication.md)
164
- * [CRDT Storage](https://github.com/pluv-io/pluv/blob/master/docs/crdt-storage.md)
165
- * [Creating Rooms](https://github.com/pluv-io/pluv/blob/master/docs/creating-rooms.md)
166
- * [`createIO` API](https://github.com/pluv-io/pluv/blob/master/docs/create-io-api.md)
167
- * [Custom Events](https://github.com/pluv-io/pluv/blob/master/docs/custom-events.md)
168
- * [Presence](https://github.com/pluv-io/pluv/blob/master/docs/presence.md)
169
- * [PubSubs and Persistance](https://github.com/pluv-io/pluv/blob/master/docs/pubsubs-and-persistance.md)
170
- * [React API](https://github.com/pluv-io/pluv/blob/master/docs/react-api.md)
112
+ Documentation is available at [pluv.io](https://pluv.io/docs/introduction).
171
113
 
172
114
  ## Related
173
115
 
@@ -191,4 +133,4 @@ This software uses the following open source tooling and libraries:
191
133
 
192
134
  ## License
193
135
 
194
- MIT
136
+ [MIT](https://github.com/pluv-io/pluv/blob/master/LICENSE)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pluv/io",
3
- "version": "0.3.4",
3
+ "version": "0.3.6",
4
4
  "description": "@pluv/io server-side websocket manager",
5
5
  "author": "leedavidcs",
6
6
  "license": "MIT",
@@ -21,7 +21,7 @@
21
21
  "jose": "^4.13.1",
22
22
  "kleur": "^4.1.5",
23
23
  "wonka": "^6.3.1",
24
- "@pluv/crdt-yjs": "^0.3.5",
24
+ "@pluv/crdt-yjs": "^0.3.6",
25
25
  "@pluv/types": "^0.1.6"
26
26
  },
27
27
  "peerDependencies": {