diff --git a/README.md b/README.md index d1babe0..e99b37b 100644 --- a/README.md +++ b/README.md @@ -2,39 +2,42 @@ JDevKit is a Java Development Kit that offers a set of convenient tools for writing code efficiently. ## Modules -### `devkit-core` + +> For more information, please visit the README file of each module. + +### `devkit-core` _[Learn more](devkit-core/README.md)_ The core module for `JDevKit`, by now, this module contains the commonly used classes of the whole `dev-kit`. -### `guid` +### `guid` _[Learn more](guid/README.md)_ A module for generating globally unique IDs. It includes a facade interface and an implementation of GUID generation using the Snowflake algorithm. More globally unique ID generation modes will be added in the future. -### `dev-utils` +### `dev-utils` _[Learn more](dev-utils/README.md)_ A collection of common utility classes to simplify Java development. It includes tools for Base64 encoding/decoding of strings, reducing if-else code blocks using Lambda expressions, converting between maps and arbitrary objects, high-precision chained mathematical calculations, and string hashing or message digest calculations. -### `simple-jwt-facade` +### `simple-jwt-facade` _[Learn more](simple-jwt-facade/README.md)_ A facade for Simple JWT (JSON Web Token) implementations in Java. This module provides a unified interface to work with JWTs regardless of the underlying implementation. -### `simple-jwt-auth0` +### `simple-jwt-auth0` _[Learn more](simple-jwt-facade/README.md)_ A Simple JWT implementation using the com.auth0:java-jwt library. -### `simple-jwt-spring-boot-starter` +### `simple-jwt-spring-boot-starter` _[Learn more](simple-jwt-spring-boot-starter/README.md)_ A Spring Boot auto-configuration wrapper for the simple-jwt module, making it easier to integrate JWT functionality into Spring Boot applications. -### `sms-sender-facade` +### `sms-sender-facade` _[Learn more](sms-sender-facade/README.md)_ A facade for sending SMS messages in Java. This module abstracts the interfaces of various SMS service providers. -### `sms-sender-aliyun` +### `sms-sender-aliyun` _[Learn more](sms-sender-aliyun/README.md)_ An implementation of SMS Sender using the Alibaba Cloud (Aliyun) service. -### `sms-sender-tencent` +### `sms-sender-tencent` _[Learn more](sms-sender-tencent/README.md)_ An implementation of SMS Sender using the Tencent Cloud service. -### `sms-sender-spring-boot-starter` +### `sms-sender-spring-boot-starter` _[Learn more](sms-sender-spring-boot-starter/README.md)_ A Spring Boot auto-configuration wrapper for the sms-sender module, simplifying the integration of SMS sending capabilities into Spring Boot applications. diff --git a/dev-utils/README.md b/dev-utils/README.md new file mode 100644 index 0000000..e69de29 diff --git a/devkit-core/README.md b/devkit-core/README.md new file mode 100644 index 0000000..e69de29 diff --git a/guid/README.md b/guid/README.md new file mode 100644 index 0000000..e69de29 diff --git a/simple-jwt-authzero/README.md b/simple-jwt-authzero/README.md new file mode 100644 index 0000000..e69de29 diff --git a/simple-jwt-facade/README.md b/simple-jwt-facade/README.md new file mode 100644 index 0000000..e69de29 diff --git a/simple-jwt-spring-boot-starter/README.md b/simple-jwt-spring-boot-starter/README.md new file mode 100644 index 0000000..e69de29