From 95683ca3deed4f01ffb524f8b05e629382063be4 Mon Sep 17 00:00:00 2001 From: Chris Ryan Date: Mon, 5 Aug 2019 18:17:47 -0400 Subject: [PATCH] feat(docs): initial readme pass & package description --- README.md | 27 ++++++++++++++++++++++++++- package.json | 2 +- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b7a668..9769365 100644 --- a/README.md +++ b/README.md @@ -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. + +``` + + + +``` diff --git a/package.json b/package.json index 9d6f8e5..959961d 100644 --- a/package.json +++ b/package.json @@ -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": {