diff --git a/README.md b/README.md new file mode 100644 index 0000000..ec8e96f --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# JDevKit +JDevKit is a Java Development Kit that offers a set of convenient tools for writing code efficiently. + +## Modules +### `guid` +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` +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` +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` +A Simple JWT implementation using the com.auth0:java-jwt library. + +### `simple-jwt-jjwt` +A Simple JWT implementation using the io.jsonwebtoken:jjwt library. + +### `simple-jwt-spring-boot-starter` +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` +A facade for sending SMS messages in Java. This module abstracts the interfaces of various SMS service providers. + +### `sms-sender-aliyun` +An implementation of SMS Sender using the Alibaba Cloud (Aliyun) service. + +### `sms-sender-tencent` +An implementation of SMS Sender using the Tencent Cloud service. + +### `sms-sender-spring-boot-starter` +A Spring Boot auto-configuration wrapper for the sms-sender module, simplifying the integration of SMS sending capabilities into Spring Boot applications. + +## Installation and Usage +If you are using `maven`, please paste the following codes to `pom.xml` in your project. + +```xml + + cn.org.codecrafters + ${artifactId} + ${version} + +``` + +If you are using `gradle`, please paste the following codes to `buile.gradle` in your project. + +```groovy +implementation 'cn.org.codecrafters:$artifactId:$version' +``` + +If you want to check the available versions, please check out at our [official site](). + +## Contribution +Contributions are welcome! If you encounter any issues or want to contribute to the project, please feel free to **[raise an issue]()** or **[submit a pull request]()**. + +## License +This project is licensed under the [Apache License 2.0](LICENSE). + +## Contact +For any questions or feedback, you can [open an issue](https://github.com/CodeCraftersCN/jdevkit/issues/new) on GitHub or join our Discord community at discord.gg/your_discord. \ No newline at end of file