blode-icons-react 0.3.6 → 0.3.7

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 +9 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -8,13 +8,17 @@
8
8
 
9
9
  ## Highlights
10
10
 
11
- - **Drop-in replacement:** swap `lucide-react` imports with zero code changes
11
+ - **Lucide-style aliases:** mapped icons can replace `lucide-react` imports with minimal code changes
12
12
  - **Tree-shakeable:** only ship the icons you use
13
13
  - **Dynamic imports:** load icons by name at runtime
14
14
  - **Lucide-compatible props:** `size`, `color`, and `strokeWidth` work out of the box
15
15
 
16
16
  ## Install
17
17
 
18
+ ```bash
19
+ npx skills add mblode/blode-icons -g --all -y
20
+ ```
21
+
18
22
  ```bash
19
23
  npm install blode-icons-react
20
24
  ```
@@ -22,17 +26,17 @@ npm install blode-icons-react
22
26
  ## Quick Start
23
27
 
24
28
  ```tsx
25
- import { Airplane } from "blode-icons-react"
29
+ import { AirplaneIcon } from "blode-icons-react"
26
30
 
27
31
  export default function App() {
28
- return <Airplane size={32} color="#0066ff" />
32
+ return <AirplaneIcon size={32} color="#0066ff" />
29
33
  }
30
34
  ```
31
35
 
32
36
  ### Tree-shaking import
33
37
 
34
38
  ```tsx
35
- import Airplane from "blode-icons-react/icons/airplane"
39
+ import AirplaneIcon from "blode-icons-react/icons/airplane"
36
40
  ```
37
41
 
38
42
  ### Dynamic icon
@@ -40,7 +44,7 @@ import Airplane from "blode-icons-react/icons/airplane"
40
44
  ```tsx
41
45
  import { DynamicIcon } from "blode-icons-react/dynamic"
42
46
 
43
- <DynamicIcon name="airplane" size={24} />
47
+ <DynamicIcon name="AirplaneIcon" size={24} />
44
48
  ```
45
49
 
46
50
  ## Props
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "blode-icons-react",
3
- "version": "0.3.6",
3
+ "version": "0.3.7",
4
4
  "description": "Blode icons for React — drop-in lucide-react replacement",
5
5
  "module": "dist/index.js",
6
6
  "types": "dist/index.d.ts",