@npm-questionpro/wick-ui-icon 1.3.1

package/README.md

@@ -0,0 +1,108 @@
+````markdown
+# @npm-questionpro/wick-ui-icon
+
+An icon font library featuring Material icons and custom icons for QuestionPro. This package generates a web font from SVG icons and provides the corresponding CSS for usage in web applications.
+
+## Features
+
+- **Material Icons**: Includes icons from Google's Material Design Icons.
+- **Custom Icons**: Allows you to include custom SVG icons by placing them in the appropriate folders.
+- **Web Font**: The icons are bundled as a web font for easy inclusion in web projects.
+- **CSS Integration**: The package generates a CSS file to easily style and use the icons.
+
+## Installation
+
+You can install the package using npm or yarn:
+
+```bash
+npm install @npm-questionpro/wick-ui-icon
+# or
+pnpm add @npm-questionpro/wick-ui-icon
+# or
+yarn add @npm-questionpro/wick-ui-icon
+```
+````
+
+## Usage
+
+1. **CSS Integration**: To use the icons in your project, include the `wu-icon.css` file in your HTML:
+
+   ```html
+   <link rel="stylesheet" href="path-to-wick-ui-icon/dist/wu-icon.css" />
+   ```
+
+2. **Font Classes**: After including the CSS file, you can use the icons by adding the corresponding class to an element. For example:
+
+   ```jsx
+   <i className="wm-home"></i>
+   ```
+
+   The class names follow the format `wc-{icon-name}`. Material icons will be prefixed with `wm-`, and custom icons with `wc-`.
+
+## Directory Structure
+
+- `svg/`: Place your custom SVG icons in this folder. The folder structure will determine the icon name prefix.
+- `dist/`: Contains the generated font and CSS file.
+- `.temp-svg/`: Temporary folder used for processing the SVG files.
+- `material-design-icons/`: Clone and update the Material Design icons repository using the provided scripts.
+
+## Scripts
+
+### Build the font
+
+To generate the icon font and CSS file from the SVG icons, run:
+
+```bash
+npm run build
+```
+
+### Release
+
+To release a new version, use the following commands:
+
+- Patch release:
+
+  ```bash
+  npm run release:patch
+  ```
+
+- Minor release:
+
+  ```bash
+  npm run release:minor
+  ```
+
+- Major release:
+  ```bash
+  npm run release:major
+  ```
+
+### Material Icons
+
+You can clone or update the Material Design icons using the following scripts:
+
+- Clone Material Design Icons. This will take a lot of time, so it's recommended to do it only once:
+
+  ```bash
+  npm run mat:clone
+  ```
+
+- Update Material Design Icons and rebuild:
+  ```bash
+  npm run mat:update
+  ```
+
+## Development
+
+### Requirements
+
+- Node.js (v18 or later)
+- pnpm (for managing dependencies)
+
+### Local Development
+
+To develop locally, you can modify the SVG icons in the `svg/` directory and run the build command to regenerate the font and CSS.
+
+### Cleaning Up Unnecessary Files
+
+During the build process, unnecessary files (like LESS, SCSS, and HTML files) will be removed to ensure a clean output.