Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
haideralsh authored Jan 5, 2024
1 parent ccbb9ba commit 49d89e9
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,14 @@ They can then be used in your application like any other `.svg`.

## ➕ Adding a new icon

Prerequisites:
- Node.js using the version in `.nvmrc`
- Yarn

To find and add a new icon:

1. Search [Material Icons](https://material.io/resources/icons/) for the icon you need
2. In Figma, use the Material Design Icons plugin to add the icon to a document. Export the icon as SVG
3. Clone this repo (`git clone https://github.com/nulogy/nds-icons.git`)
4. Install dependencies by running `yarn`
5. Place SVG in `assets/` folder with the desired icon name (in camelCase)
6. run `yarn && yarn build` to make the icon available to use
7. Commit the changes using a [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) message
8. Submit PR
4. Place SVG in `assets/` folder with the desired icon name (in camelCase)
5. Commit the changes using a [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) message
6. Submit PR

## 💬 Questions

Expand Down

0 comments on commit 49d89e9

Please sign in to comment.