material-design-icons-literal-types 1.0.6 → 1.0.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 (3) hide show
  1. package/README.md +18 -4
  2. package/index.d.ts +2 -0
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -6,20 +6,34 @@ It allows you to use the icon names with type safety in your TypeScript projects
6
6
 
7
7
  ## Installation
8
8
 
9
- Install the package using npm:
9
+ > Install the package
10
10
 
11
11
  ```bash
12
- npm install material-design-icons-literal-types
12
+ npm install -D material-design-icons-literal-types
13
+ ```
14
+
15
+ ```bash
16
+ pnpm add -D material-design-icons-literal-types
17
+ ```
18
+
19
+ ```bash
20
+ yarn add -D material-design-icons-literal-types
13
21
  ```
14
22
 
15
23
  ## Usage
16
24
 
17
- Import the desired icon type from the package:
25
+ > Import the desired icon type from the package
18
26
 
19
27
  ```typescript
20
28
  import {MaterialSymbols} from 'material-design-icons-literal-types'
21
29
 
22
- const myIcon: MaterialSymbols = 'home'
30
+ const mySymbol: MaterialSymbols = 'home'
31
+ ```
32
+
33
+ ```typescript
34
+ import {MaterialIcons} from 'material-design-icons-literal-types'
35
+
36
+ const myIcon: MaterialIcons = 'home'
23
37
  ```
24
38
 
25
39
  The package provides the following literal types:
package/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export {MaterialSymbols} from './dist/material-symbols';
2
+ export {MaterialIcons} from './dist/material-icons';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "material-design-icons-literal-types",
3
- "version": "1.0.6",
3
+ "version": "1.0.7",
4
4
  "description": "",
5
5
  "scripts": {
6
6
  "start": "node src/index.js",
@@ -25,6 +25,7 @@
25
25
  },
26
26
  "files": [
27
27
  "README.md",
28
+ "index.d.ts",
28
29
  "dist"
29
30
  ],
30
31
  "standard": {
@@ -36,4 +37,4 @@
36
37
  "jest": "^29.7.0",
37
38
  "standard": "^17.1.0"
38
39
  }
39
- }
40
+ }