![Run tests](https://github.com/nordhealth/design-system/actions/workflows/tests.yml/badge.svg) ![Publish packages to production](https://github.com/nordhealth/design-system/actions/workflows/publish-production.yml/badge.svg) ![Deploy to GitHub Pages](https://github.com/nordhealth/design-system/actions/workflows/deploy.yml/badge.svg)

# Nordicons

Nordicons package found from `packages/icons` utilizes simple SVG files and JSON format for the meta data. The following are the most commonly used commands during development:

- `pnpm build` - Builds the project.
- `pnpm test` - Run all tests once.
- `pnpm test -- -u` - Runs all tests once and updates failing screenshot snapshots.
- `pnpm tags` - Run CLI helper util to add category and tags to any icons, plus format and sort metadata file.

## Adding icon(s)

1. Export the icon(s) as an SVG file(s), making sure they’ve been resized to match our standard sizing and compressed adequately.
2. Add the file(s) to the `src/assets` directory within the `icons` package.
3. Run `pnpm tags` and follow the steps to update the project with the new icon(s).
4. Run `pnpm test` to test the new icon(s) and add screenshot snapshots.

## License

See license in LICENSE.md

## Copyright

Copyright © 2025 Nordhealth Ltd.