From f9549e79e74d2862259f16eb62ac21de7de44afd Mon Sep 17 00:00:00 2001 From: Zihlu Wang Date: Mon, 7 Aug 2023 18:59:59 +0800 Subject: [PATCH] docs(global): Updated docs --- README.md | 69 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 49 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 2ddfb14..e03f953 100644 --- a/README.md +++ b/README.md @@ -5,28 +5,57 @@ JDevKit is a Java Development Kit that offers a set of convenient tools for writ > For more information, please visit the README file of each module. -### `devkit-core` _[Learn more](./devkit-core/README.md)_ +### `devkit-core` + +_[Learn more](https://github.com/CodeCraftersCN/jdevkit/devkit-core/README.md)_ + The core module for `JDevKit`, by now, this module contains the commonly used classes of the whole `dev-kit`. -### `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. +### `devkit-utils` -### `devkit-utils` _[Learn more](./devkit-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. +_[Learn more](https://github.com/CodeCraftersCN/jdevkit/devkit-utils/README.md)_ -### `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. +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. + +### `guid` + +_[Learn more](https://github.com/CodeCraftersCN/jdevkit/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. + +### `WebCal` + +_[Learn more](https://github.com/CodeCraftersCN/jdevkit/webcal/README.md)_ + +The module `webcal` is a Java library that facilitates the generation and resolution of iCalendar content for web-based calendar applications. It provides a flexible and easy-to-use API for creating web calendars with customizable settings and events. + +With the `webcal` module, developers can easily integrate calendar functionality into web applications, enabling users to view, add, and manage events in a structured and standardized format. It is designed to simplify calendar-related tasks and enhance the overall user experience when dealing with calendar data on the web. + +Please note that the `webcal` module adheres to the iCalendar standard specified in RFC 5545, ensuring compatibility with other calendar applications that support this format. + +### `simple-jwt-facade` + +_[Learn more](https://github.com/CodeCraftersCN/jdevkit/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-authzero` + +_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-authzero/README.md)_ -### `simple-jwt-authzero` _[Learn more](./simple-jwt-facade/README.md)_ A Simple JWT implementation using the com.auth0:java-jwt library. -### `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. +### `simple-jwt-jjwt` + +_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-jjwt/README.md)_ + +A Simple JWT implementation using the `io.jsonwebtoken:jjwt-api` library. + +### `simple-jwt-spring-boot-starter` + +_[Learn more](https://github.com/CodeCraftersCN/jdevkit/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. ## Installation and Usage If you are using `maven`, please paste the following codes to `pom.xml` in your project. @@ -45,15 +74,15 @@ If you are using `gradle`, please paste the following codes to `buile.gradle` in implementation 'cn.org.codecrafters:$artifactId:$version' ``` -If you want to check the available versions, please check out at our [official site](). +If you want to check the available versions, please check out at our [official site](https://codecrafters.org.cn/devkit/changelog). ## Contribution -Contributions are welcome! If you encounter any issues or want to contribute to the project, please feel free to -**[raise an issue](https://github.com/CodeCraftersCN/jdevkit/issues/new)** or **[submit a pull request](https://github.com/CodeCraftersCN/jdevkit/compare)**. +Contributions are welcome! If you encounter any issues or want to contribute to the project, please feel free to **[raise an issue](https://github.com/CodeCraftersCN/jdevkit/issues/new)** or **[submit a pull request](https://github.com/CodeCraftersCN/jdevkit/compare)**. ## 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](). \ No newline at end of file +If you have any suggestions, ideas, don't hesitate contacting us via [GitHub Issues](https://github.com/CodeCraftersCN/jdevkit/issues/new) or [Discord Community](https://discord.gg/NQK9tjcBB8). + +If you face any bugs while using our library and you are able to fix any bugs in our library, we would be happy to accept pull requests from you on [GitHub](https://github.com/CodeCraftersCN/jdevkit/compare). \ No newline at end of file