vadivam 0.0.20 → 0.0.22

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 -16
  2. package/package.json +8 -3
package/README.md CHANGED
@@ -1,11 +1,15 @@
1
1
  # vadivam
2
2
 
3
- Pixel-perfect, open-source, gorgeous SVG icons for refined interfaces.
3
+ Pixel-perfect 24px outline SVG icons with tree-shakeable ESM imports and metadata.
4
4
 
5
- ![All Vadivam icons](https://raw.githubusercontent.com/praveenjuge/vadivam/main/apps/web/public/preview.png?v=0.0.20)
5
+ [![npm version](https://img.shields.io/npm/v/vadivam?style=flat-square&color=111)](https://www.npmjs.com/package/vadivam)
6
+ [![downloads](https://img.shields.io/npm/dw/vadivam?style=flat-square&color=666)](https://www.npmjs.com/package/vadivam)
7
+ [![license](https://img.shields.io/npm/l/vadivam?style=flat-square&color=111)](https://github.com/praveenjuge/vadivam/blob/main/LICENSE)
8
+
9
+ ![All Vadivam icons](https://raw.githubusercontent.com/praveenjuge/vadivam/main/apps/web/public/preview.png?v=0.0.22)
6
10
 
7
11
  ```sh
8
- bun add vadivam
12
+ npm install vadivam
9
13
  ```
10
14
 
11
15
  ```js
@@ -15,13 +19,7 @@ import activitySvgUrl from "vadivam/icons/activity.svg";
15
19
  const svg = createElement(Activity, { width: 20, height: 20 });
16
20
  ```
17
21
 
18
- Icon nodes are also available through tree-shakable subpaths:
19
-
20
- ```js
21
- import Activity from "vadivam/icons/activity";
22
- ```
23
-
24
- Replace elements in HTML using `createIcons`:
22
+ Replace elements in HTML with the DOM helper:
25
23
 
26
24
  ```html
27
25
  <i data-vadivam="activity" aria-label="Activity"></i>
@@ -33,10 +31,8 @@ import { createIcons, icons } from "vadivam";
33
31
  createIcons({ icons });
34
32
  ```
35
33
 
36
- `createIcons` accepts `attrs`, `nameAttr`, `root`, and `inTemplates`. Pass a
37
- shadow root through `root`, or set `inTemplates: true` to process template
38
- contents. The complete metadata collection remains available as `manifest`,
39
- or from `vadivam/manifest`.
34
+ - Tree-shakeable icon nodes and direct SVG asset imports
35
+ - DOM replacement with configurable attributes, roots, and templates
36
+ - Complete icon metadata from `vadivam/manifest`
40
37
 
41
- The canonical source lives in the repository root `icons/` folder. Package
42
- files are generated during build.
38
+ [Browse icons](https://vadivam.praveenjuge.com) · [GitHub](https://github.com/praveenjuge/vadivam) · [Issues](https://github.com/praveenjuge/vadivam/issues)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "vadivam",
3
- "version": "0.0.20",
4
- "description": "Pixel-perfect, open-source, gorgeous SVG icons for refined interfaces.",
3
+ "version": "0.0.22",
4
+ "description": "Pixel-perfect 24px outline SVG icons with tree-shakeable ESM imports and metadata.",
5
5
  "license": "MIT",
6
6
  "author": "Praveen Juge",
7
7
  "repository": {
@@ -16,9 +16,14 @@
16
16
  "keywords": [
17
17
  "icons",
18
18
  "svg",
19
+ "outline-icons",
20
+ "icon-library",
19
21
  "icon-pack",
22
+ "24px",
23
+ "tree-shakeable",
20
24
  "open-source",
21
- "vadivam"
25
+ "vadivam",
26
+ "javascript"
22
27
  ],
23
28
  "type": "module",
24
29
  "sideEffects": false,