@storm-ds/icons 0.1.1 → 1.0.0

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 +1 -60
  2. package/package.json +2 -3
package/README.md CHANGED
@@ -1,60 +1 @@
1
- # @storm-ds/icons
2
-
3
- Simple, clean icon set for modern web apps — 486 icons.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- npm install @storm-ds/icons
9
- # or
10
- pnpm add @storm-ds/icons
11
- ```
12
-
13
- ## Usage
14
-
15
- ### React Components
16
-
17
- ```tsx
18
- import { ArrowRight, Home, Check } from '@storm-ds/icons'
19
-
20
- export default function MyComponent() {
21
- return (
22
- <div>
23
- <Home className="w-6 h-6" />
24
- <ArrowRight className="w-6 h-6 text-blue-600" />
25
- <Check className="w-4 h-4" />
26
- </div>
27
- )
28
- }
29
- ```
30
-
31
- All icons accept standard SVG props (`className`, `style`, `width`, `height`, etc.) and forward refs.
32
-
33
- ### Raw SVG
34
-
35
- For non-React frameworks (Astro, Vue, Svelte, etc.):
36
-
37
- ```js
38
- import arrowRight from '@storm-ds/icons/svg/arrow-right.svg'
39
- ```
40
-
41
- ### Metadata
42
-
43
- Access the full icon list programmatically:
44
-
45
- ```tsx
46
- import { iconMeta } from '@storm-ds/icons/metadata'
47
-
48
- // iconMeta: Array<{ name: string, componentName: string, keywords: string[] }>
49
- ```
50
-
51
- ## Icon Specs
52
-
53
- - 24x24 viewBox
54
- - `currentColor` for strokes/fills
55
- - 2px stroke width
56
- - Kebab-case filenames
57
-
58
- ## License
59
-
60
- MIT
1
+ # storm-icons
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storm-ds/icons",
3
- "version": "0.1.1",
3
+ "version": "1.0.0",
4
4
  "description": "Simple, clean icon set for modern web apps",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -21,8 +21,7 @@
21
21
  "sideEffects": false,
22
22
  "repository": {
23
23
  "type": "git",
24
- "url": "https://github.com/saayym/storm-project.git",
25
- "directory": "packages/icons"
24
+ "url": "https://github.com/saayym/storm-icons.git"
26
25
  },
27
26
  "homepage": "https://storm-project-web.vercel.app/docs/icons",
28
27
  "bugs": {