-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): initial readme pass & package description
- Loading branch information
1 parent
5ca55ac
commit 95683ca
Showing
2 changed files
with
27 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,26 @@ | ||
# svelte-icons | ||
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) | ||
[![NPM: svelte-icons](https://badge.fury.io/js/svelte-icons.svg)](https://www.npmjs.com/package/svelte-icons) | ||
[![Build Status](https://travis-ci.org/gibdig/svelte-icons.svg?branch=master)](https://travis-ci.org/gibdig/svelte-icons) | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | ||
|
||
### Svelte Icons | ||
|
||
Icon components for svelte. | ||
|
||
### Installation | ||
|
||
``` | ||
npm install --save svelte-icons | ||
``` | ||
|
||
### Usage | ||
|
||
Visit the [icon navigator](https://www.svelte-icons.gibdig.com), to quickly search through the available icon sets. Click an icon to copy the import statement to your clipboard. | ||
|
||
``` | ||
<script> | ||
import ChevronCircleUp from 'svelte-icons/fa/FaChevronCircleUp.svelte'; | ||
</script> | ||
<ChevronCircleUp /> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters