2
0
mirror of https://github.com/iconify/iconify.git synced 2024-12-12 21:57:50 +00:00
iconify/packages/core/README.md
2023-11-12 19:36:23 +02:00

32 lines
1.3 KiB
Markdown

# Iconify Core
Iconify is the most versatile icon framework.
- Unified icon framework that can be used with any icon library.
- Out of the box includes 150+ icon sets with 200,000 icons.
- Embed icons in HTML with SVG framework or components for front-end frameworks.
- Embed icons in designs with plug-ins for Figma and Sketch.
- Add icon search to your applications with Iconify Icon Finder.
For more information visit [https://iconify.design/](https://iconify.design/).
Iconify Core contains code shared among various Iconify implementations.
## Documentation
Documentation is currently not available because there is no demand for it.
If anyone would like to create custom Iconify implementation and needs documentation for Iconify Core, please create an issue on Iconify repository on GitHub.
You can browse [icon components documentation](https://iconify.design/docs/icon-components/), which explains how most functions exported by core package work. Components mostly just re-export functions from this package.
## License
This package is licensed under MIT license.
`SPDX-License-Identifier: MIT`
Previous versions of this package were dual-licensed under Apache 2.0 and GPL 2.0 licence, which was messy and confusing. This was later changed to MIT for simplicity.
© 2021-PRESENT Vjacheslav Trushkin