Skip to content

Commit

Permalink
chore(build-icons): generate icon index
Browse files Browse the repository at this point in the history
Closes #1
  • Loading branch information
metonym committed Dec 15, 2019
1 parent 7dec404 commit 07988f3
Show file tree
Hide file tree
Showing 3 changed files with 3,733 additions and 10 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
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.

## [Icon Index](docs/ICON_INDEX.md)

## Install

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

## Usage

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

### Basic

```html
Expand All @@ -41,14 +45,6 @@ For faster compiling, import icons individually.
<Add16 />
```

#### Import Path Pattern

```js
import Icon from 'carbon-icons-svelte/lib/<module-name>';
```

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.

## API

### Props
Expand Down
Loading

0 comments on commit 07988f3

Please sign in to comment.