Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Further explain the process for updating icons
  • Loading branch information
haideralsh authored Oct 4, 2024
1 parent 24489b2 commit 83c5cc1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ They can then be used in your application like any other `.svg`.

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. Place SVG in `assets/` folder with the desired icon name (in camelCase)
1. Search [Material Icons](https://material.io/resources/icons/) for the icon you need and download it. Alternatively, in Figma, use the Material Design Icons plugin to add the icon to a page then export the icon as SVG
2. Add the icon to the NDS design system `Icons` page in [Figma](https://www.figma.com/design/IH4gk9P2E4xEYiNKoD22Jd/NDS-v1?node-id=113-851)
3. Clone this repo (`git clone git@github.com:nulogy/nds-icons.git`)
4. Place SVG in `assets/` folder with the desired icon name (in camelCase). The name of the icon should match the icon's name in Figma. Consult with the designer what the desired name should be, otherwise use the name provided in Material Icons
5. Commit the changes using a [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) message
6. Submit PR

Expand Down

0 comments on commit 83c5cc1

Please sign in to comment.