onixbyte/onixbyte-bom
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(global): Updated docs

Browse Source
This commit is contained in:
Zihlu Wang
2023-08-07 18:59:59 +08:00
parent e7a4deb9b6
commit f9549e79e7
1 changed files with 49 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+49 -20
View File
@@ -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. > For more information, please visit the README file of each module.
### `devkit-core` <span style="font-size: 14px;">_[Learn more](./devkit-core/README.md)_</span> ### `devkit-core`
<span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/devkit-core/README.md)_</span>
The core module for `JDevKit`, by now, this module contains the commonly used classes of the whole `dev-kit`. The core module for `JDevKit`, by now, this module contains the commonly used classes of the whole `dev-kit`.
### `guid` <span style="font-size: 14px;">_[Learn more](./guid/README.md)_</span> ### `devkit-utils`
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` <span style="font-size: 14px;">_[Learn more](./devkit-utils/README.md)_</span> <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/devkit-utils/README.md)_</span>
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` <span style="font-size: 14px;">_[Learn more](./simple-jwt-facade/README.md)_</span> 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.
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. ### `guid`
<span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/guid/README.md)_</span>
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`
<span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/webcal/README.md)_</span>
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`
<span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-facade/README.md)_</span>
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`
<span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-authzero/README.md)_</span>
### `simple-jwt-authzero` <span style="font-size: 14px;">_[Learn more](./simple-jwt-facade/README.md)_</span>
A Simple JWT implementation using the com.auth0:java-jwt library. A Simple JWT implementation using the com.auth0:java-jwt library.
### `simple-jwt-spring-boot-starter` <span style="font-size: 14px;">_[Learn more](./simple-jwt-spring-boot-starter/README.md)_</span> ### `simple-jwt-jjwt`
A Spring Boot auto-configuration wrapper for the simple-jwt module, making it easier to integrate JWT functionality into
Spring Boot applications. <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-jjwt/README.md)_</span>
A Simple JWT implementation using the `io.jsonwebtoken:jjwt-api` library.
### `simple-jwt-spring-boot-starter`
<span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-spring-boot-starter/README.md)_</span>
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 ## Installation and Usage
If you are using `maven`, please paste the following codes to `pom.xml` in your project. 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' 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 ## Contribution
Contributions are welcome! If you encounter any issues or want to contribute to the project, please feel free to 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)**.
**[raise an issue](https://github.com/CodeCraftersCN/jdevkit/issues/new)** or **[submit a pull request](https://github.com/CodeCraftersCN/jdevkit/compare)**.
## License ## License
This project is licensed under the [Apache License 2.0](LICENSE). This project is licensed under the [Apache License 2.0](LICENSE).
## Contact ## Contact
For any questions or feedback, you can [open an issue](https://github.com/CodeCraftersCN/jdevkit/issues/new) on GitHub 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).
or join our [Discord community]().
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).