magtool 1.5.14 → 1.5.18

package/README.md

@@ -1 +1,37 @@
-# magtool
+# magtool
+
+## Key Features
+
+### 📦  Ready to use tool library out of the box
+Provide high-frequency tool functions required for daily development, covering data processing, format conversion, verification, time operation, etc., uniformly encapsulated and introduced on demand.
+
+### 🏗️  Preset project architecture
+Built in directory structure, state management solution, routing encapsulation, and API organization that meet the characteristics of SaaS projects, supporting fast initialization of standard projects.
+
+### 📊  Reusable charts and components
+Contains a series of commonly used business chart components encapsulated in modern chart libraries, as well as high-level Table, Form and other components, supporting configurable generation and reducing duplicate coding.
+
+### 🔄  Built in linkage logic
+Provide standardized solutions for data linkage and status synchronization between multiple components, such as form linkage, table and filter linkage, etc., to improve the development efficiency of complex interactions.
+
+### ⚙️  Encapsulate commonly used algorithms and logic
+For SaaS scenarios, integrate common algorithms such as permission determination, data filtering, and query optimization to avoid redundant implementation.
+
+## Why did you choose it?
+
+If you are developing SaaS projects using Vite+Vue 3 and wish to:
+
+Quickly establish a standardized project framework to avoid zero configuration;
+
+Directly call business components such as encapsulated charts, tables, forms, etc;
+
+Save time on writing common linkage logic and utility functions;
+
+Maintain consistency in project structure and code style while ensuring development speed.
+
+So this is a highly matched set of tools that can significantly improve your development efficiency.
+
+## Note
+
+This toolkit is designed to enhance development convenience, therefore it has strong coupling. Some modules assume that the project operates in a typical Vue 3+Vite+SaaS environment and do not pursue completely universal scalability. If you need a highly pluggable abstract tool library that is suitable for multiple scenarios, this may not be the most suitable choice; But if you are focusing on SaaS projects and the technology stack is aligned, it will save you a lot of repetitive labor.
+