@npm-questionpro/wick-ui-icon 8.0.0 → 8.0.2

package/README.md

@@ -116,3 +116,72 @@ To develop locally, you can modify the SVG icons in the `svg/` directory and run
 ### Cleaning Up Unnecessary Files
 
 During the build process, unnecessary files (like LESS, SCSS, and HTML files) will be removed to ensure a clean output.
+
+---
+
+# Icon Contribution Guide
+
+Follow the steps below to create and add a new icon to the project:
+
+## Steps
+
+### 1. Download SVG Icons
+
+- Open **Figma** and download the required icons in **SVG format**.
+
+### 2. Upload to Icomoon
+
+- Go to the [Icomoon App](https://icomoon.io/app/).
+- Upload the downloaded **SVG icons**.
+- Verify that the icons render correctly.
+- Download the generated package from Icomoon.
+
+### 3. Install Dependencies
+
+Make sure the required dev dependencies are installed:
+
+```bash
+pnpm install -D svgo svgtofont
+```
+
+Run:
+
+```bash
+pnpm install
+```
+
+### 4. Build the Package
+
+```bash
+pnpm build
+```
+
+### 5. Version Update
+
+Choose the appropriate version update:
+
+```bash
+pnpm version patch   # for bug fixes
+pnpm version minor   # for new features
+pnpm version major   # for breaking changes
+```
+
+### 6. Push to Repository
+
+```bash
+git push
+```
+
+### 7. Generate Icons
+
+Run the icon generation script:
+
+```bash
+node wickIcon.js
+```
+
+> ⚡ Make sure to run this command from the **wick-ui-lib** directory.
+
+---
+
+✅ Done! The new icons should now be available in the project.