@storm-ds/icons 0.1.0 → 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.
- package/README.md +1 -57
- package/package.json +18 -9
package/README.md
CHANGED
|
@@ -1,57 +1 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
Simple, clean icon set for modern web apps.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install storm-icons
|
|
9
|
-
# or
|
|
10
|
-
pnpm add storm-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
|
-
### Raw SVG (for other frameworks)
|
|
32
|
-
|
|
33
|
-
```tsx
|
|
34
|
-
// For Astro, Vue, Svelte, etc.
|
|
35
|
-
import arrowRight from '@storm-ds/icons/svg/arrow-right.svg'
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
## Building Icons
|
|
39
|
-
|
|
40
|
-
Add SVG files to `svg/` directory and run:
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
pnpm build
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
This will generate React components automatically.
|
|
47
|
-
|
|
48
|
-
## Icon Requirements
|
|
49
|
-
|
|
50
|
-
- 24x24 viewBox
|
|
51
|
-
- Use `currentColor` for strokes/fills
|
|
52
|
-
- Clean, optimized paths
|
|
53
|
-
- Descriptive filename (kebab-case)
|
|
54
|
-
|
|
55
|
-
## License
|
|
56
|
-
|
|
57
|
-
MIT
|
|
1
|
+
# storm-icons
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storm-ds/icons",
|
|
3
|
-
"version": "
|
|
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",
|
|
@@ -19,11 +19,26 @@
|
|
|
19
19
|
"./svg/*": "./svg/*.svg"
|
|
20
20
|
},
|
|
21
21
|
"sideEffects": false,
|
|
22
|
+
"repository": {
|
|
23
|
+
"type": "git",
|
|
24
|
+
"url": "https://github.com/saayym/storm-icons.git"
|
|
25
|
+
},
|
|
26
|
+
"homepage": "https://storm-project-web.vercel.app/docs/icons",
|
|
27
|
+
"bugs": {
|
|
28
|
+
"url": "https://github.com/saayym/storm-project/issues"
|
|
29
|
+
},
|
|
22
30
|
"files": [
|
|
23
31
|
"dist",
|
|
24
32
|
"svg",
|
|
25
|
-
"README.md"
|
|
33
|
+
"README.md",
|
|
34
|
+
"LICENSE"
|
|
26
35
|
],
|
|
36
|
+
"scripts": {
|
|
37
|
+
"build": "node build.js && tsup",
|
|
38
|
+
"dev": "tsup --watch",
|
|
39
|
+
"lint": "eslint src",
|
|
40
|
+
"clean": "rm -rf dist src/*.tsx node_modules"
|
|
41
|
+
},
|
|
27
42
|
"keywords": [
|
|
28
43
|
"react",
|
|
29
44
|
"icons",
|
|
@@ -41,11 +56,5 @@
|
|
|
41
56
|
"svgo": "^4.0.0",
|
|
42
57
|
"tsup": "^8.0.1",
|
|
43
58
|
"typescript": "^5.3.3"
|
|
44
|
-
},
|
|
45
|
-
"scripts": {
|
|
46
|
-
"build": "node build.js && tsup",
|
|
47
|
-
"dev": "tsup --watch",
|
|
48
|
-
"lint": "eslint src",
|
|
49
|
-
"clean": "rm -rf dist src/*.tsx node_modules"
|
|
50
59
|
}
|
|
51
|
-
}
|
|
60
|
+
}
|