@pluv/io 0.2.1 → 0.2.2

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 +9 -0
  3. package/README.md +7 -6
  4. package/package.json +7 -7
package/.turbo/turbo-build.log CHANGED
@@ -1,5 +1,5 @@
1
1
 
2
- > @pluv/io@0.2.1 build /home/runner/work/pluv/pluv/packages/io
2
+ > @pluv/io@0.2.2 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 28.59 KB
12
- CJS ⚡️ Build success in 95ms
13
11
  ESM dist/index.mjs 26.79 KB
14
- ESM ⚡️ Build success in 96ms
12
+ ESM ⚡️ Build success in 104ms
13
+ CJS dist/index.js 28.59 KB
14
+ CJS ⚡️ Build success in 106ms
15
15
  DTS Build start
16
- DTS ⚡️ Build success in 2778ms
16
+ DTS ⚡️ Build success in 2852ms
17
17
  DTS dist/index.d.ts 12.86 KB
package/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # @pluv/io
2
2
 
3
+ ## 0.2.2
4
+
5
+ ### Patch Changes
6
+
7
+ - fe80d7b: added preview disclaimer about breaking changes in the readme
8
+ - Updated dependencies [fe80d7b]
9
+ - @pluv/crdt-yjs@0.1.3
10
+ - @pluv/types@0.1.2
11
+
3
12
  ## 0.2.1
4
13
 
5
14
  ### Patch Changes
package/README.md CHANGED
@@ -1,3 +1,6 @@
1
+ > **Disclaimer:**
2
+ > This package is currently in preview and may have breaking changes between versions. Please wait for a `v1.0.0` stable release before using this in production.
3
+
1
4
  <h1 align="center">
2
5
  <br>
3
6
  <img src="https://github.com/pluv-io/pluv/blob/master/assets/pluv-icon-192x192.png?raw=true" alt="Pluv.IO" width="180" style="border-radius:16px">
@@ -20,7 +23,7 @@
20
23
  <a href="https://commitizen.github.io/cz-cli/">
21
24
  <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" />
22
25
  </a>
23
- <img src="https://img.shields.io/badge/docs-coming%20soon!-blue" alt="Docs coming soon!" />
26
+ <img src="https://img.shields.io/badge/website-coming%20soon!-blue" alt="Website coming soon!" />
24
27
  </p>
25
28
 
26
29
  <p align="center">
@@ -33,13 +36,11 @@
33
36
 
34
37
  <img src="https://github.com/pluv-io/pluv/blob/master/assets/demo-events.gif?raw=true" alt="Demo" />
35
38
 
36
- <h3 align="center">Documentation Website coming soon!</h3>
37
-
38
39
  ## Intro
39
40
 
40
41
  Pluv.IO allows you to build real-time collaborate features with a fully end-to-end type-safe api.
41
42
 
42
- ### Why
43
+ ### Why?
43
44
 
44
45
  So you can do this:
45
46
 
@@ -101,7 +102,7 @@ return (
101
102
  );
102
103
  ```
103
104
 
104
- And more. With great **E2E type-safety**, **intellisense** and the **[yjs](https://docs.yjs.dev/) ecosystem**.
105
+ And more. With **E2E type-safety**, **great intellisense** and the **[yjs](https://docs.yjs.dev/) ecosystem**.
105
106
 
106
107
  ### Features
107
108
 
@@ -142,7 +143,7 @@ And more. With great **E2E type-safety**, **intellisense** and the **[yjs](https
142
143
 
143
144
  Before diving into documentation, check out usage instructions for your selected platform:
144
145
 
145
- > **Note**
146
+ > **Note:**
146
147
  > `@pluv/io`, `@pluv/client`, `@pluv/crdt-yjs` and `@pluv/react` all require [yjs](https://docs.yjs.dev/) as a peer dependency.
147
148
 
148
149
  ### Platforms
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pluv/io",
3
- "version": "0.2.1",
3
+ "version": "0.2.2",
4
4
  "description": "@pluv/io server-side websocket manager",
5
5
  "author": "leedavidcs",
6
6
  "license": "MIT",
@@ -18,21 +18,21 @@
18
18
  },
19
19
  "dependencies": {
20
20
  "@panva/hkdf": "^1.0.2",
21
- "@pluv/crdt-yjs": "^0.1.2",
22
- "@pluv/types": "^0.1.1",
23
21
  "chalk": "^4.1.2",
24
22
  "jose": "^4.11.2",
25
- "wonka": "^6.1.2"
23
+ "wonka": "^6.1.2",
24
+ "@pluv/crdt-yjs": "^0.1.3",
25
+ "@pluv/types": "^0.1.2"
26
26
  },
27
27
  "peerDependencies": {
28
28
  "yjs": "^13.0.0"
29
29
  },
30
30
  "devDependencies": {
31
- "@pluv/tsconfig": "^0.1.1",
32
- "eslint-config-pluv": "^0.1.1",
33
31
  "tsup": "^6.5.0",
34
32
  "typescript": "^4.9.4",
35
- "yjs": "^13.5.44"
33
+ "yjs": "^13.5.44",
34
+ "@pluv/tsconfig": "^0.1.2",
35
+ "eslint-config-pluv": "^0.1.2"
36
36
  },
37
37
  "scripts": {
38
38
  "build": "tsup src/index.ts --format esm,cjs --dts",