# Planning Center Icons
Accessible, scaleable, cacheable, and standard SVG icons for [Planning Center](https://planning.center) apps


## References

- [Installation](./docs/INSTALLATION.md)
- [Usage](./docs/USAGE.md)
- [Development Scripts](#development-scripts)
- [Contributing](./docs/CONTRIBUTING.md)
- [Publishing](./docs/PUBLISHING.md)
- [Releases (changelog)](https://github.com/planningcenter/icons/releases)
- [Actions](https://github.com/planningcenter/icons/actions)

## Links

- [Figma](https://www.figma.com/file/5WSYCrTtlQvFeOUZoakwR4/Icons)
- [Storybook](https://planningcenter.github.io/icons/)
- [Docs/Reference](https://planningcenter.github.io/icons/docs/)

### Packages

  - [npm package (preferred)](https://www.npmjs.com/package/@planningcenter/icons)
  - [GitHub (experimental)](https://github.com/planningcenter/icons/packages/167210)

### Helpers and Components

  - [React — @planningcenter/symbol](https://www.npmjs.com/package/@planningcenter/symbol)
  - [Rails — interfaces#planningcenter_svg_use_tag](https://github.com/ministrycentered/interfaces/blob/master/app/helpers/interfaces/application_helper.rb#L19-L64)

# Development Scripts

- `yarn build`: creates sprites/paths from SVGs & builds local documentation/reference page
- `yarn start`: builds local documentation/reference page (at `http://localhost:1234` by default)
- `yarn storybook`: starts local Storybook instance (at `http://localhost:6006` by default)
- `yarn deploy`: builds documentation and deploys to Github pages

# Reference Guides

- [Contributing](./docs/CONTRIBUTING.md)
- [Publishing](./docs/PUBLISHING.md)