@pluv/io 0.3.3 → 0.3.5

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 +4 -4
  2. package/CHANGELOG.md +17 -0
  3. package/README.md +4 -57
  4. package/package.json +5 -5
package/.turbo/turbo-build.log CHANGED
@@ -1,5 +1,5 @@
1
1
 
2
- > @pluv/io@0.3.3 build /home/runner/work/pluv/pluv/packages/io
2
+ > @pluv/io@0.3.5 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
@@ -9,9 +9,9 @@
9
9
  ESM Build start
10
10
  CJS Build start
11
11
  CJS dist/index.js 29.25 KB
12
- CJS ⚡️ Build success in 88ms
12
+ CJS ⚡️ Build success in 92ms
13
13
  ESM dist/index.mjs 27.19 KB
14
- ESM ⚡️ Build success in 90ms
14
+ ESM ⚡️ Build success in 93ms
15
15
  DTS Build start
16
- DTS ⚡️ Build success in 2864ms
16
+ DTS ⚡️ Build success in 2672ms
17
17
  DTS dist/index.d.ts 12.73 KB
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @pluv/io
2
2
 
3
+ ## 0.3.5
4
+
5
+ ### Patch Changes
6
+
7
+ - 78fd644: updated readmes with links to the documentation website
8
+ - Updated dependencies [78fd644]
9
+ - @pluv/crdt-yjs@0.3.6
10
+
11
+ ## 0.3.4
12
+
13
+ ### Patch Changes
14
+
15
+ - 850626e: bumped dependencies
16
+ - Updated dependencies [850626e]
17
+ - @pluv/crdt-yjs@0.3.5
18
+ - @pluv/types@0.1.6
19
+
3
20
  ## 0.3.3
4
21
 
5
22
  ### 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
@@ -160,14 +114,7 @@ Before diving into documentation, check out usage instructions for your selected
160
114
 
161
115
  ### Documentation
162
116
 
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)
117
+ Documentation is available at [pluv.io](https://pluv.io/docs/introduction).
171
118
 
172
119
  ## Related
173
120
 
@@ -191,4 +138,4 @@ This software uses the following open source tooling and libraries:
191
138
 
192
139
  ## License
193
140
 
194
- MIT
141
+ [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.3",
3
+ "version": "0.3.5",
4
4
  "description": "@pluv/io server-side websocket manager",
5
5
  "author": "leedavidcs",
6
6
  "license": "MIT",
@@ -21,18 +21,18 @@
21
21
  "jose": "^4.13.1",
22
22
  "kleur": "^4.1.5",
23
23
  "wonka": "^6.3.1",
24
- "@pluv/crdt-yjs": "^0.3.4",
25
- "@pluv/types": "^0.1.5"
24
+ "@pluv/crdt-yjs": "^0.3.6",
25
+ "@pluv/types": "^0.1.6"
26
26
  },
27
27
  "peerDependencies": {
28
28
  "yjs": "^13.0.0"
29
29
  },
30
30
  "devDependencies": {
31
31
  "tsup": "^6.7.0",
32
- "typescript": "^5.0.3",
32
+ "typescript": "^5.0.4",
33
33
  "yjs": "^13.5.52",
34
34
  "@pluv/tsconfig": "^0.1.5",
35
- "eslint-config-pluv": "^0.1.9"
35
+ "eslint-config-pluv": "^0.1.10"
36
36
  },
37
37
  "scripts": {
38
38
  "build": "tsup src/index.ts --format esm,cjs --dts",