# Modus Icons

[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/trimble-oss/modus-icons/main/LICENSE)
[![npm Version](https://img.shields.io/npm/v/@trimble-oss/modus-icons)](https://www.npmjs.com/package/@trimble-oss/modus-icons)
[![npm Downloads](https://img.shields.io/npm/dt/@trimble-oss/modus-icons.svg)](https://www.npmjs.com/package/@trimble-oss/modus-icons)

Open source icon library for Modus with over 1000 icons.

## Install

Modus Icons are packaged up and published to npm as processed SVGs, SVG sprites and ligature web fonts. [Read our docs](https://modus-icons.trimble.com/) for usage instructions.

```shell
npm i @trimble-oss/modus-icons
```

## Usage

Depending on your setup, you can include Modus Icons in a handful of ways.

- Use the web font
- Copy-paste SVGs as embedded HTML
- Reference via `<img>` element
- Use the SVG sprite
- Include via CSS

[See the docs for more information.](https://modus-icons.trimble.com)

## Development

[![Build Status](https://github.com/trimble-oss/modus-icons/workflows/Tests/badge.svg)](https://github.com/trimble-oss/modus-icons/actions?workflow=Tests)

Read the [CONTRIBUTING.md](Contributing) guide for details on how to contribute.

## Adding SVGs

See the [CONTRIBUTING.md](https://github.com/trimble-oss/modus-icons/blob/main/CONTRIBUTING.md) guide for details.

## Publishing

Documentation is published automatically when a new Git tag is published. See our [GitHub Actions](https://github.com/trimble-oss/modus-icons/tree/main/.github/workflows) and [`package.json`](https://github.com/trimble-oss/modus-icons/blob/main/package.json) for more information.

## License

MIT
