Skip to content

Commit

Permalink
updates ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
halfmage committed Apr 21, 2020
1 parent 38e6ad8 commit c41285d
Showing 1 changed file with 9 additions and 15 deletions.
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,26 @@
# Pixel Art Icons
# Pixelarticons [Website](https://pixelarticons.com "Pixelarticons - Website")

![npm](https://img.shields.io/npm/v/pixelarticons.svg?color=green&label=npm&style=popout-square)
![npm](https://img.shields.io/npm/dt/pixelarticons.svg?color=blue&style=popout-square)

## What is Pixel Art Icons?
## What are pixelarticons?

Finest handmade pixelart icons based on a 24x24 grid. For retro vibes. https://pixelarticons.com
Finest handmade pixelart icons based on a 24x24 grid. For retro vibes.

## Gettings Started

### Using the iconfont

The `iconfont` folder contains the font files that can be included in a project. You can access the latest version of pixelarticons like this:

```html
<link href="https://unpkg.com/pixelarticons@latest/pixelarticons.css" rel="stylesheet">
```

### Using svg

```shell
npm install pixelarticons --save
```javascript
npm install pixelarticons
// or
yarn add pixelarticons
```

By installing the npm-package your are able to access all icons from the `icons` folder via import:

```html
import FileIcon from "pixelarticons/icons/file.svg"
```jsx
import File from "pixelarticons/svg/file.svg"
```

## Examples
Expand Down

0 comments on commit c41285d

Please sign in to comment.