Skip to content

Commit 07988f3

Browse files
committed
chore(build-icons): generate icon index
Closes #1
1 parent 7dec404 commit 07988f3

File tree

3 files changed

+3733
-10
lines changed

3 files changed

+3733
-10
lines changed

README.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
1010
This library uses [@carbon/icons](https://github.com/carbon-design-system/carbon/tree/master/packages/icons) to build [Carbon icons](https://www.carbondesignsystem.com/guidelines/icons/library) with zero dependencies.
1111

12+
## [Icon Index](docs/ICON_INDEX.md)
13+
1214
## Install
1315

1416
```bash
@@ -19,6 +21,8 @@ npm install -D carbon-icons-svelte
1921

2022
## Usage
2123

24+
Supported icon sizes include `16`, `20`, `24` and `32`. Refer to the [Icon Index](docs/ICON_INDEX.md) for a list of available icons.
25+
2226
### Basic
2327

2428
```html
@@ -41,14 +45,6 @@ For faster compiling, import icons individually.
4145
<Add16 />
4246
```
4347

44-
#### Import Path Pattern
45-
46-
```js
47-
import Icon from 'carbon-icons-svelte/lib/<module-name>';
48-
```
49-
50-
Supported icon sizes include `16`, `20`, `24` and `32`. Refer to the [Carbon icon library](https://www.carbondesignsystem.com/guidelines/icons/library) for the full list of available icons.
51-
5248
## API
5349

5450
### Props

0 commit comments

Comments
 (0)