Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
samshara committed Jun 30, 2023
1 parent df2ff27 commit 2caa2e0
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## IFRC-GO Icons ![npm (scoped)](https://img.shields.io/npm/v/@ifrc-go/icons)
## IFRC-GO Icons ![npm (scoped)](https://img.shields.io/npm/v/@ifrc-go/icons) [![Build](https://github.com/IFRCGo/go-icons/actions/workflows/ci.yml/badge.svg)](https://github.com/IFRCGo/go-icons/actions/workflows/ci.yml) [![Release & Publish](https://github.com/IFRCGo/go-icons/actions/workflows/release.yml/badge.svg)](https://github.com/IFRCGo/go-icons/actions/workflows/release.yml)
React icons for [IFRC-GO](https://github.com/IFRCGo/) project.

## Installation
Expand All @@ -8,17 +8,16 @@ yarn add @ifrc-go/icons
npm install @ifrc-go/icons
```

## Gh Pages
Dev
## GitHub Pages
For local development
```
docker-compose up page-dev
```

Build
For building the NextJS project
```
docker-compose up page-build
```
> WHY? next will use icons configuration which can cause issue

## Usage

Expand Down

0 comments on commit 2caa2e0

Please sign in to comment.