From b7727b3c7df49ea7f228d9c705f26ca17a89ec1d Mon Sep 17 00:00:00 2001 From: Zihlu Wang Date: Sat, 24 Feb 2024 03:58:03 +0800 Subject: [PATCH] docs: Updated README docs. --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++---- webcal/README.md | 6 ++---- 2 files changed, 48 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 603bca4..21e00f5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # JDevKit + JDevKit is a Java Development Kit that offers a set of convenient tools for writing code efficiently. ## Modules @@ -55,25 +56,66 @@ A Simple JWT implementation using the `io.jsonwebtoken:jjwt-api` library. _[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. +A Spring Boot autoconfiguration 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. + +### Before Installation + +For **Chinese Mainland** users, it is suggested to use maven packages services provided by coding.net. + +You could follow the following steps to configure. + +#### For Maven + +You could add the following codes to register Coding Nexus to your Maven. + +```xml + + codecrafters-coding-nexus + codecrafters-coding-nexus + https://codecrafters-maven.pkg.coding.net/repository/common-productions/maven-packages/ + + true + + + true + + +``` + +#### For Gradle + +You could add a new repository to Gradle repositories closure. + +```groovy +maven { url 'https://codecrafters-maven.pkg.coding.net/repository/common-productions/maven-packages/' } +``` + +```kotlin +maven(url = "https://codecrafters-maven.pkg.coding.net/repository/common-productions/maven-packages/") +``` + +If you are using **Maven**, please paste the following codes to _pom.xml_ in your project. ```xml - cn.org.codecrafters + cn.org.codecrafters ${artifactId} ${version} ``` -If you are using `gradle`, please paste the following codes to `buile.gradle` in your project. +If you are using **Gradle**, please paste the following codes to _buile.gradle\[.kts\]_ in your project. ```groovy implementation 'cn.org.codecrafters:$artifactId:$version' ``` +```kotlin +implementation("cn.org.codecrafters:$artifactId:$version") +``` + If you want to check the available versions, please check out at our [official site](https://codecrafters.org.cn/devkit/changelog). ## Contribution diff --git a/webcal/README.md b/webcal/README.md index d421196..3ea4034 100644 --- a/webcal/README.md +++ b/webcal/README.md @@ -22,20 +22,18 @@ Please note that the `webcal` module adheres to the iCalendar standard specified ## Installation -## Installation - ### If you are using `Maven` 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 `` node in the `` node, and add the following codes to `` node: ```xml - ${implementation-builder-group-id} + ${implementation-builder-group-id} simple-jwt-${any-implementation} ${simple-jwt-${any-implementation}.version} - cn.org.codecrafters + cn.org.codecrafters simple-jwt-spring-boot-starter ${simple-jwt-spring-boot-starter.version}