3d-marquee 0.2.0 → 0.2.1

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 (2) hide show
  1. package/README.md +12 -4
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -6,16 +6,24 @@ A React library featuring a 3D rotating orb with a scrolling LED marquee effect.
6
6
 
7
7
  ## Installation
8
8
 
9
- Install the package and its peer dependencies:
9
+ Install the package:
10
10
 
11
11
  ```bash
12
- npm install 3d-marquee @react-three/fiber @react-three/drei @react-three/postprocessing react react-dom three
12
+ npm install 3d-marquee
13
+ ```
14
+
15
+ **Note:** With npm 7+ and yarn, peer dependencies are automatically installed. If you're using npm 6 or earlier, you'll need to install the peer dependencies manually:
16
+
17
+ ```bash
18
+ npm install 3d-marquee react react-dom three @react-three/fiber @react-three/drei @react-three/postprocessing
13
19
  ```
14
20
 
15
21
  ### Peer Dependencies
16
22
 
17
- - `react`: `^18.2.0 || ^19.0.0`
18
- - `react-dom`: `^18.2.0 || ^19.0.0`
23
+ The following peer dependencies are required and will be automatically installed with npm 7+:
24
+
25
+ - `react`: `^18.0.0 || ^19.0.0`
26
+ - `react-dom`: `^18.0.0 || ^19.0.0`
19
27
  - `three`: `>=0.158.0`
20
28
  - `@react-three/fiber`: `^8.15.11 || ^9.0.0`
21
29
  - `@react-three/drei`: `^9.92.7 || ^10.0.0`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "3d-marquee",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "type": "module",
5
5
  "main": "./dist/3d-marquee.umd.js",
6
6
  "module": "./dist/3d-marquee.es.js",
@@ -34,8 +34,8 @@
34
34
  "@react-three/drei": "^9.92.7 || ^10.0.0",
35
35
  "@react-three/fiber": "^8.15.11 || ^9.0.0",
36
36
  "@react-three/postprocessing": "^2.15.9 || ^3.0.0",
37
- "react": "^18.2.0 || ^19.0.0",
38
- "react-dom": "^18.2.0 || ^19.0.0",
37
+ "react": "^18.0.0 || ^19.0.0",
38
+ "react-dom": "^18.0.0 || ^19.0.0",
39
39
  "three": ">=0.158.0"
40
40
  },
41
41
  "devDependencies": {