Skip to content

Commit b7727b3

Browse files
author
Zihlu Wang
committed
docs: Updated README docs.
1 parent fa27fdb commit b7727b3

File tree

2 files changed

+48
-8
lines changed

2 files changed

+48
-8
lines changed

README.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# JDevKit
2+
23
JDevKit is a Java Development Kit that offers a set of convenient tools for writing code efficiently.
34

45
## Modules
@@ -55,25 +56,66 @@ A Simple JWT implementation using the `io.jsonwebtoken:jjwt-api` library.
5556

5657
<span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/simple-jwt-spring-boot-starter/README.md)_</span>
5758

58-
A Spring Boot auto-configuration wrapper for the simple-jwt module, making it easier to integrate JWT functionality into Spring Boot applications.
59+
A Spring Boot autoconfiguration wrapper for the simple-jwt module, making it easier to integrate JWT functionality into Spring Boot applications.
5960

6061
## Installation and Usage
61-
If you are using `maven`, please paste the following codes to `pom.xml` in your project.
62+
63+
### Before Installation
64+
65+
For **Chinese Mainland** users, it is suggested to use maven packages services provided by coding.net.
66+
67+
You could follow the following steps to configure.
68+
69+
#### For Maven
70+
71+
You could add the following codes to register Coding Nexus to your Maven.
72+
73+
```xml
74+
<repository>
75+
<id>codecrafters-coding-nexus</id>
76+
<name>codecrafters-coding-nexus</name>
77+
<url>https://codecrafters-maven.pkg.coding.net/repository/common-productions/maven-packages/</url>
78+
<releases>
79+
<enabled>true</enabled>
80+
</releases>
81+
<snapshots>
82+
<enabled>true</enabled>
83+
</snapshots>
84+
</repository>
85+
```
86+
87+
#### For Gradle
88+
89+
You could add a new repository to Gradle repositories closure.
90+
91+
```groovy
92+
maven { url 'https://codecrafters-maven.pkg.coding.net/repository/common-productions/maven-packages/' }
93+
```
94+
95+
```kotlin
96+
maven(url = "https://codecrafters-maven.pkg.coding.net/repository/common-productions/maven-packages/")
97+
```
98+
99+
If you are using **Maven**, please paste the following codes to _pom.xml_ in your project.
62100

63101
```xml
64102
<dependency>
65-
<groupId>cn.org.codecrafters</groupId>
103+
<groupId>cn.org.codecrafters</groupId>
66104
<artifactId>${artifactId}</artifactId>
67105
<version>${version}</version>
68106
</dependency>
69107
```
70108

71-
If you are using `gradle`, please paste the following codes to `buile.gradle` in your project.
109+
If you are using **Gradle**, please paste the following codes to _buile.gradle\[.kts\]_ in your project.
72110

73111
```groovy
74112
implementation 'cn.org.codecrafters:$artifactId:$version'
75113
```
76114

115+
```kotlin
116+
implementation("cn.org.codecrafters:$artifactId:$version")
117+
```
118+
77119
If you want to check the available versions, please check out at our [official site](https://codecrafters.org.cn/devkit/changelog).
78120

79121
## Contribution

webcal/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,18 @@ Please note that the `webcal` module adheres to the iCalendar standard specified
2222

2323
## Installation
2424

25-
## Installation
26-
2725
### If you are using `Maven`
2826

2927
It is quite simple to install this module by `Maven`. The only thing you need to do is find your `pom.xml` file in the project, then find the `<dependencies>` node in the `<project>` node, and add the following codes to `<dependencies>` node:
3028

3129
```xml
3230
<dependency>
33-
<groupId>${implementation-builder-group-id}</groupId>
31+
<groupId>${implementation-builder-group-id}</groupId>
3432
<artifactId>simple-jwt-${any-implementation}</artifactId>
3533
<version>${simple-jwt-${any-implementation}.version}</version>
3634
</dependency>
3735
<dependency>
38-
<groupId>cn.org.codecrafters</groupId>
36+
<groupId>cn.org.codecrafters</groupId>
3937
<artifactId>simple-jwt-spring-boot-starter</artifactId>
4038
<version>${simple-jwt-spring-boot-starter.version}</version>
4139
</dependency>

0 commit comments

Comments
 (0)