diff --git a/README.md b/README.md index 3811816..819fa39 100644 --- a/README.md +++ b/README.md @@ -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 - -``` - ### 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