# Seeds Illustrations

This package contains all the assets for spot illustrations used by Sprout Social. This package is automatically updated with Figma.

### Installation

Run the following command to install `@sproutsocial/seeds-illustrations`:

```sh
yarn add @sproutsocial/seeds-illustrations
```

### Usage

It is recommended to use this package in conjunction with `@sproutsocial/racine` and the `SpotIllustration` component. Check your version of Racine's peer dependencies to know exactly which versions of this package are compatible.

In order for the SVG assets to be utilized in your application, they need to be loaded onto the page. This can be done utilizing the sprite sheet found at `dist/sprites/index.svg` or by using the `Sprite` string export.

For additional guidance on loading SVGs in an application, please visit [the documentation on the reference site](https://seeds.sproutsocial.com/components/getting-started/#using-svgs).

For more details on using the `SpotIllustration` component check out [the documentation on the reference site](https://seeds.sproutsocial.com/components/spot-illustration/).

### Adding a new illustration or modifying an existing one

To add a new logo to this package, the logo should be added to Sprout Social's Figma page for spot illustrations. This page is used as a source of truth for assets in this package. Similarly, to modify a logo in this package, modify the corresponding logo on the Figma page.

A GitHub Action triggers twice a day to retrieve the assets from Figma and create a PR containing any changes. After the PR is approved and merged, a release is created for this package with the latest changes.
