Skip to content

Commit 7905b0d

Browse files
author
zihluwang
committed
docs: updated project README
1 parent cf7e5ef commit 7905b0d

File tree

1 file changed

+3
-79
lines changed

1 file changed

+3
-79
lines changed

README.md

Lines changed: 3 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -2,89 +2,13 @@
22

33
JDevKit is a Java Development Kit that offers a set of convenient tools for writing code efficiently.
44

5-
## Modules
6-
7-
> For more information, please visit the README file of each module.
8-
9-
### `devkit-core` <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/devkit-core/README.md)_</span>
10-
11-
The core module for `JDevKit`, by now, this module contains the commonly used classes of the whole `dev-kit`.
12-
13-
### `devkit-utils` <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/devkit-utils/README.md)_</span>
14-
15-
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.
16-
17-
### `guid` <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/guid/README.md)_</span>
18-
19-
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.
20-
21-
### `WebCal` <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/webcal/README.md)_</span>
22-
23-
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 customisable settings and events.
24-
25-
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.
26-
27-
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.
28-
29-
### `simple-jwt-facade` <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-facade/README.md)_</span>
30-
31-
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.
32-
33-
### `simple-jwt-authzero` <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-authzero/README.md)_</span>
34-
35-
A Simple JWT implementation using the com.auth0:java-jwt library.
36-
37-
### `simple-jwt-jjwt` <span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-jjwt/README.md)_</span>
38-
39-
A Simple JWT implementation using the `io.jsonwebtoken:jjwt-api` library.
40-
41-
### `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>
42-
43-
A Spring Boot autoconfiguration wrapper for the simple-jwt module, making it easier to integrate JWT functionality into Spring Boot applications.
44-
455
## Installation and Usage
466

47-
### Before Installation
48-
49-
For **Chinese Mainland** users, it is suggested to use maven packages services provided by coding.net.
50-
51-
You could follow the following steps to configure.
52-
53-
#### For Maven
54-
55-
You could add the following codes to register Coding Nexus to your Maven.
56-
57-
```xml
58-
<repository>
59-
<id>codecrafters-coding-nexus</id>
60-
<name>codecrafters-coding-nexus</name>
61-
<url>https://codecrafters-maven.pkg.coding.net/repository/common-productions/maven-packages/</url>
62-
<releases>
63-
<enabled>true</enabled>
64-
</releases>
65-
<snapshots>
66-
<enabled>true</enabled>
67-
</snapshots>
68-
</repository>
69-
```
70-
71-
#### For Gradle
72-
73-
You could add a new repository to Gradle repositories closure.
74-
75-
```groovy
76-
maven { url 'https://codecrafters-maven.pkg.coding.net/repository/common-productions/maven-packages/' }
77-
```
78-
79-
```kotlin
80-
maven(url = "https://codecrafters-maven.pkg.coding.net/repository/common-productions/maven-packages/")
81-
```
82-
837
If you are using **Maven**, please paste the following codes to _pom.xml_ in your project.
848

859
```xml
8610
<dependency>
87-
<groupId>cn.org.codecrafters</groupId>
11+
<groupId>com.onixbyte</groupId>
8812
<artifactId>${artifactId}</artifactId>
8913
<version>${version}</version>
9014
</dependency>
@@ -93,11 +17,11 @@ If you are using **Maven**, please paste the following codes to _pom.xml_ in you
9317
If you are using **Gradle**, please paste the following codes to _buile.gradle\[.kts\]_ in your project.
9418

9519
```groovy
96-
implementation 'cn.org.codecrafters:$artifactId:$version'
20+
implementation 'com.onixbyte:$artifactId:$version'
9721
```
9822

9923
```kotlin
100-
implementation("cn.org.codecrafters:$artifactId:$version")
24+
implementation("com.onixbyte:$artifactId:$version")
10125
```
10226

10327
If you want to check the available versions, please check out at our [official site](https://codecrafters.org.cn/devkit/changelog).

0 commit comments

Comments
 (0)