Add README.md for @xola/icons package

xola · Feb 18, 2024 · e023b99 · e023b99
1 parent d4aff7c
commit e023b99
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/src/icons/README.md 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
+```