diff --git a/src/icons/README.md b/src/icons/README.md new file mode 100644 index 000000000..d51186af5 --- /dev/null +++ b/src/icons/README.md @@ -0,0 +1,18 @@ +## Xola Icons + +Xola's icon set exposed as React components. This folder is published on NPM as [@xola/icons](https://www.npmjs.com/package/@xola/icons). + +The preview for icons are published as part of the repository's storybook on [ui.xola.io](https://ui.xola.io/?path=/story/media-icons--large-24-px). + +### Requirements + +- Node.js v16 +- NPM v7 or higher + +### Usage + +Install the icons + +```bash +npm install @xola/icons +```