Skip to content

Commit 2ccf8ff

Browse files
committed
update docs
1 parent b4478fe commit 2ccf8ff

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,19 @@ English | [中文](README_cn.md)
4444

4545
## About The Project
4646

47+
Summer is a minimized AOP (Aspect-Oriented Programming) and IoC (Inversion of Control) kernel tool library. It provides a set of validators and related utility classes to simplify the validation logic of objects and collections. Additionally, it includes some functions for batch task processing.
48+
49+
### Validation Module
50+
51+
+ Rich Validation Rules: The validation module offers a wide range of validation rules, including length checks, regular expression matching, and
52+
collection size validations. For example, you can easily validate strings for minimum and maximum lengths, and collections for size ranges.
53+
54+
+ Annotation-Based Validation: Supports annotation-based validation. You can use custom annotations to mark fields in classes and perform
55+
validation operations on objects. For instance, use the @NotNull and @Pattern annotations to validate user-defined objects.
56+
57+
+ +Collection Validation: Provides specific validation capabilities for collections. You can set validation rules for the entire collection as well
58+
as for each element in the collection.
59+
4760
## Getting Started
4861

4962
### Prerequisites

README_cn.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@
4141
<!-- TOC -->
4242

4343
## 项目简介
44+
Summer 是一个最小化的 AOP(面向切面编程)和 IoC(控制反转)内核工具库。它提供了一系列的验证器和相关工具类,用于简化对象和集合的验证逻辑,同时也包含了一些批量任务处理的功能。
45+
46+
### 验证模块 | Validation Module
47+
+ 丰富的验证规则:验证模块提供了广泛的验证规则,包括长度检查、正则表达式匹配和集合大小验证。例如,您可以轻松验证字符串的最小和最大长度,以及集合的大小范围。
48+
+ 基于注解的验证:支持基于注解的验证。您可以使用自定义注解标记类中的字段,并对对象执行验证操作。例如,使用 @NotNull@Pattern 注解来验证用户定义的对象。
49+
+ 集合验证:为集合提供特定的验证功能。您可以为整个集合以及集合中的每个元素设置验证规则。
4450

4551
## 入门指南
4652

0 commit comments

Comments
 (0)