@cruxkit/icon 0.0.1 → 0.0.3

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 +4 -10
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -8,12 +8,12 @@
8
8
  </div>
9
9
 
10
10
  <div align="center">
11
- <img src="https://img.shields.io/badge/v-0.0.1-black"/>
11
+ <img src="https://img.shields.io/badge/v-0.0.3-black"/>
12
12
  <a href="https://github.com/cruxkit-org"><img src="https://img.shields.io/badge/🔥-@cruxkit-black"/></a>
13
13
  <br>
14
14
  <img src="https://img.shields.io/badge/coverage-99%25-brightgreen" alt="Test Coverage" />
15
- <img src="https://img.shields.io/github/issues/cruxkit-orgx/icon?style=flat" alt="Github Repo Issues" />
16
- <img src="https://img.shields.io/github/stars/cruxkit-orgx/icon?style=social" alt="GitHub Repo stars" />
15
+ <img src="https://img.shields.io/github/issues/cruxkit-org/icon?style=flat" alt="Github Repo Issues" />
16
+ <img src="https://img.shields.io/github/stars/cruxkit-org/icon?style=social" alt="GitHub Repo stars" />
17
17
  </div>
18
18
  <br>
19
19
 
@@ -44,7 +44,7 @@
44
44
 
45
45
  ```ts
46
46
  // in your ts files
47
- import { ... } from `@cruxkit/icon`;
47
+ import { Icon } from `@cruxkit/icon`;
48
48
  ```
49
49
 
50
50
  <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> </div>
@@ -54,16 +54,12 @@
54
54
  - ### Basic usage
55
55
 
56
56
  ```typescript
57
- import { Icon } from '@cruxkit/icon';
58
-
59
57
  const ChevronDown = Icon('chevron-down');
60
58
  ```
61
59
 
62
60
  - ### With options
63
61
 
64
62
  ```typescript
65
- import { Icon } from '@cruxkit/icon';
66
-
67
63
  const LargePrimaryChevron = Icon({
68
64
  name : 'chevron-down',
69
65
  size : 'xl',
@@ -74,8 +70,6 @@
74
70
  - ### Custom SVG
75
71
 
76
72
  ```typescript
77
- import { Icon } from '@cruxkit/icon';
78
-
79
73
  const CustomCircle = Icon({
80
74
  svg : `<circle cx="12" cy="12" r="10" />`,
81
75
  viewBox : '0 0 24 24',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cruxkit/icon",
3
- "version": "0.0.1",
3
+ "version": "0.0.3",
4
4
  "description": "A lightweight, type-safe icon library offering full TypeScript support and effortless customization.",
5
5
  "keywords": ["crux", "kit", "icon"],
6
6
  "license": "MIT",