Skip to content

Commit

Permalink
feat(docs): initial readme pass & package description
Browse files Browse the repository at this point in the history
  • Loading branch information
AnxiousDarkly committed Aug 5, 2019
1 parent 5ca55ac commit 95683ca
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
27 changes: 26 additions & 1 deletion README.md
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 />
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "svelte-icons",
"version": "0.0.0-development",
"description": "Svg icons for svelte",
"description": "Icon components for svelte",
"author": "Chris Ryan",
"license": "MIT",
"scripts": {
Expand Down

0 comments on commit 95683ca

Please sign in to comment.