diff --git a/README.md b/README.md
index 50d5e2d..8960cb8 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
```
-README LANGUAGES [ [ENGLISH](README_enUS.md) | [中文](README.md) ]
+README LANGUAGES [ [**ENGLISH**](README.md) | [中文](README_zh_CN.md) ]
# GithubReleases4J
@@ -16,43 +16,45 @@ README LANGUAGES [ [ENGLISH](README_enUS.md) | [中文](README.md) ]
[![License](https://img.shields.io/github/license/CarmJos/GithubReleases4J)](https://opensource.org/licenses/GPL-3.0)
[![workflow](https://github.com/CarmJos/GithubReleases4J/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/GithubReleases4J/actions/workflows/maven.yml)
![CodeSize](https://img.shields.io/github/languages/code-size/CarmJos/GithubReleases4J)
+![Support](https://img.shields.io/badge/Minecraft-Java%201.16--Latest-green)
![](https://visitor-badge.glitch.me/badge?page_id=GithubReleases4J.readme)
-GitHub Releases for Java , 基于 [GitHub REST API](https://docs.github.com/cn/rest/reference/releases) 实现。
+GitHub Releases for Java , based on [GitHub REST API](https://docs.github.com/cn/rest/reference/releases) .
-本项目对 GitHub Releases 相关的信息进行了封装,方便开发直接进行使用。
+To provide an easy way to fetch updates and download assets.
-## 包含功能
+## Functions
-- Release 的基本信息
- - Tag版本号、标题、内容介绍等
-- Release 的作者信息
- - ID 、头像、身份等
-- Release 的附件信息
- - 附件的名称、类型、大小、下载链接等
- - 支持直接对附件进行下载
+- Release Info
+ - Tag Name
+ - Release Name
+ - Release Descriptions
+ - ...
+- Release's Author Info
+ - Login ID
+ - AvatarURL
+ - ...
+- Release's Assets Info
+ - Name
+ - Size
+ - ...
+- Release's Assets Download
-## 依赖方式
+## Dependency Usage
-展开查看 Maven 依赖方式
+Maven dependency
```xml
-
+
GithubReleases4J
GitHub Packages
https://maven.pkg.github.com/CarmJos/GithubReleases4J
-
-
- carm-repo
- Carm's Repo
- https://repo.carm.cc/repository/maven-public/
-
@@ -70,15 +72,12 @@ GitHub Releases for Java , 基于 [GitHub REST API](https://docs.github.com/cn/r
-展开查看 Gradle 依赖方式
+Gradle dependency
```groovy
repositories {
- // 采用github依赖库,安全稳定,但需要配置 (推荐)
+ // Using github packages.
maven { url 'https://maven.pkg.github.com/CarmJos/GithubReleases4J' }
-
- // 采用我的私人依赖库,简单方便,但可能因为变故而无法使用
- maven { url 'https://repo.carm.cc/repository/maven-public/' }
}
dependencies {
@@ -88,69 +87,10 @@ dependencies {
-## 开发示例
+## DEMO Code
-```java
-import cc.carm.lib.githubreleases4j.*;
+Please [click here]() to read the demo codes.
-import java.io.IOException;
+## Open Source License.
-public class demo {
-
- public void onTest() {
-
- List releases = GithubReleases4J.listReleases("作者名", "项目名");
- //获取Releases列表
-
- GithubRelease latestRelease = GithubReleases4J.getLatestRelease(
- "作者名", "项目名",
- "Token" // 如果是私有项目,可以填写一个OAuth Token来获取信息和下载构件
- ); // 获得最后一次的Release
-
- if (lastRelease != null) {
-
- List assets = latestRelease.getAssets();
- // 获取该 Release 的附件列表
-
- for (GithubAsset asset : assets) {
- try {
- asset.download(null); // 以默认名称下载到当前目录
- } catch (IOException exception) {
- exception.printStackTrace();
- }
- }
-
- GithubUser author = latestRelease.getAuthor(); //获取该Release的作者
-
- }
- }
-
-}
-```
-
-## 支持与捐赠
-
-若您觉得本项目做的不错,您可以 [点击这里](https://donate.carm.cc) 捐赠支持我!
-
-## 开源协议
-
-本项目源码采用 [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0) 开源协议。
-
-
-关于 GPL 协议
-
-> GNU General Public Licence (GPL) 有可能是开源界最常用的许可模式。GPL 保证了所有开发者的权利,同时为使用者提供了足够的复制,分发,修改的权利:
->
-> #### 可自由复制
-> 你可以将软件复制到你的电脑,你客户的电脑,或者任何地方。复制份数没有任何限制。
-> #### 可自由分发
-> 在你的网站提供下载,拷贝到U盘送人,或者将源代码打印出来从窗户扔出去(环保起见,请别这样做)。
-> #### 可以用来盈利
-> 你可以在分发软件的时候收费,但你必须在收费前向你的客户提供该软件的 GNU GPL 许可协议,以便让他们知道,他们可以从别的渠道免费得到这份软件,以及你收费的理由。
-> #### 可自由修改
-> 如果你想添加或删除某个功能,没问题,如果你想在别的项目中使用部分代码,也没问题,唯一的要求是,使用了这段代码的项目也必须使用 GPL 协议。
->
-> 需要注意的是,分发的时候,需要明确提供源代码和二进制文件,另外,用于某些程序的某些协议有一些问题和限制,你可以看一下 @PierreJoye 写的 Practical Guide to GPL Compliance 一文。使用 GPL 协议,你必须在源代码代码中包含相应信息,以及协议本身。
->
-> *以上文字来自 [五种开源协议GPL,LGPL,BSD,MIT,Apache](https://www.oschina.net/question/54100_9455) 。*
-
+The project using [The MIT License](https://opensource.org/licenses/MIT) .
diff --git a/README_enUS.md b/README_enUS.md
deleted file mode 100644
index 2177eb7..0000000
--- a/README_enUS.md
+++ /dev/null
@@ -1,22 +0,0 @@
-```text
- _____ _ _ _ _ _____ _ _ _ _
- / ____(_) | | | | | | __ \ | | | || | | |
-| | __ _| |_| |__ _ _| |__ | |__) |___| | ___ __ _ ___ ___ ___| || |_ | |
-| | |_ | | __| '_ \| | | | '_ \| _ // _ \ |/ _ \/ _` / __|/ _ \/ __|__ _| | |
-| |__| | | |_| | | | |_| | |_) | | \ \ __/ | __/ (_| \__ \ __/\__ \ | || |__| |
- \_____|_|\__|_| |_|\__,_|_.__/|_| \_\___|_|\___|\__,_|___/\___||___/ |_| \____/
-
-```
-
-README LANGUAGES [ [ENGLISH](README_enUS.md) | [中文](README) ]
-
-# GithubReleases4J
-
-[![version](https://img.shields.io/github/v/release/CarmJos/GithubReleases4J)](https://github.com/CarmJos/GithubReleases4J/releases)
-[![License](https://img.shields.io/github/license/CarmJos/GithubReleases4J)](https://opensource.org/licenses/GPL-3.0)
-[![workflow](https://github.com/CarmJos/GithubReleases4J/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/GithubReleases4J/actions/workflows/maven.yml)
-![CodeSize](https://img.shields.io/github/languages/code-size/CarmJos/GithubReleases4J)
-![Support](https://img.shields.io/badge/Minecraft-Java%201.16--Latest-green)
-![](https://visitor-badge.glitch.me/badge?page_id=GithubReleases4J.readme)
-
-GitHub Releases for Java , based on [GitHub REST API](https://docs.github.com/cn/rest/reference/releases) .
diff --git a/README_zh_CN.md b/README_zh_CN.md
new file mode 100644
index 0000000..052ccba
--- /dev/null
+++ b/README_zh_CN.md
@@ -0,0 +1,118 @@
+```text
+ _____ _ _ _ _ _____ _ _ _ _
+ / ____(_) | | | | | | __ \ | | | || | | |
+| | __ _| |_| |__ _ _| |__ | |__) |___| | ___ __ _ ___ ___ ___| || |_ | |
+| | |_ | | __| '_ \| | | | '_ \| _ // _ \ |/ _ \/ _` / __|/ _ \/ __|__ _| | |
+| |__| | | |_| | | | |_| | |_) | | \ \ __/ | __/ (_| \__ \ __/\__ \ | || |__| |
+ \_____|_|\__|_| |_|\__,_|_.__/|_| \_\___|_|\___|\__,_|___/\___||___/ |_| \____/
+
+```
+
+README LANGUAGES [ [ENGLISH](README.md) | [**中文**](README_zh_CN.md) ]
+
+# GithubReleases4J
+
+[![version](https://img.shields.io/github/v/release/CarmJos/GithubReleases4J)](https://github.com/CarmJos/GithubReleases4J/releases)
+[![License](https://img.shields.io/github/license/CarmJos/GithubReleases4J)](https://opensource.org/licenses/GPL-3.0)
+[![workflow](https://github.com/CarmJos/GithubReleases4J/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/GithubReleases4J/actions/workflows/maven.yml)
+![CodeSize](https://img.shields.io/github/languages/code-size/CarmJos/GithubReleases4J)
+![](https://visitor-badge.glitch.me/badge?page_id=GithubReleases4J.readme)
+
+GitHub Releases for Java , 基于 [GitHub REST API](https://docs.github.com/cn/rest/reference/releases) 实现。
+
+本项目对 GitHub Releases 相关的信息进行了封装,方便开发直接进行使用。
+
+## 包含功能
+
+- Release 的基本信息
+ - Tag版本号、标题、内容介绍等
+- Release 的作者信息
+ - ID 、头像、身份等
+- Release 的附件信息
+ - 附件的名称、类型、大小、下载链接等
+ - 支持直接对附件进行下载
+
+## 依赖方式
+
+
+展开查看 Maven 依赖方式
+
+```xml
+
+
+
+
+
+ GithubReleases4J
+ GitHub Packages
+ https://maven.pkg.github.com/CarmJos/GithubReleases4J
+
+
+
+ carm-repo
+ Carm's Repo
+ https://repo.carm.cc/repository/maven-public/
+
+
+
+
+
+ cc.carm.lib
+ githubreleases4j
+ [LATEST RELEASE]
+ compile
+
+
+
+
+```
+
+
+
+
+展开查看 Gradle 依赖方式
+
+```groovy
+repositories {
+ // 采用github依赖库,安全稳定,但需要配置 (推荐)
+ maven { url 'https://maven.pkg.github.com/CarmJos/GithubReleases4J' }
+
+ // 采用我的私人依赖库,简单方便,但可能因为变故而无法使用
+ maven { url 'https://repo.carm.cc/repository/maven-public/' }
+}
+
+dependencies {
+ api "cc.carm.lib:githubreleases4j:[LATEST RELEASE]"
+}
+```
+
+
+
+## 开发示例
+
+请 [**点击这里**](src/test/java/GithubDemo.java) 查看示例代码。
+
+## 支持与捐赠
+
+若您觉得本项目做的不错,您可以 [点击这里](https://donate.carm.cc) 捐赠支持我!
+
+## 开源协议
+
+本项目源码采用 [The MIT License](https://opensource.org/licenses/MIT) 开源协议。
+
+
+关于 MIT 协议
+
+> MIT 协议可能是几大开源协议中最宽松的一个,核心条款是:
+>
+> 该软件及其相关文档对所有人免费,可以任意处置,包括使用,复制,修改,合并,发表,分发,再授权,或者销售。唯一的限制是,软件中必须包含上述版 权和许可提示。
+>
+> 这意味着:
+> - 你可以自由使用,复制,修改,可以用于自己的项目。
+> - 可以免费分发或用来盈利。
+> - 唯一的限制是必须包含许可声明。
+>
+> MIT 协议是所有开源许可中最宽松的一个,除了必须包含许可声明外,再无任何限制。
+>
+> *以上文字来自 [五种开源协议GPL,LGPL,BSD,MIT,Apache](https://www.oschina.net/question/54100_9455) 。*
+
\ No newline at end of file
diff --git a/src/test/java/GithubDemo.java b/src/test/java/GithubDemo.java
new file mode 100644
index 0000000..d2c209e
--- /dev/null
+++ b/src/test/java/GithubDemo.java
@@ -0,0 +1,42 @@
+import cc.carm.lib.githubreleases4j.GithubAsset;
+import cc.carm.lib.githubreleases4j.GithubRelease;
+import cc.carm.lib.githubreleases4j.GithubReleases4J;
+import cc.carm.lib.githubreleases4j.GithubUser;
+
+import java.io.IOException;
+import java.util.List;
+
+public class GithubDemo {
+
+ public void demo() {
+
+ List releases = GithubReleases4J.listReleases("Owner", "RepoName");
+ // List a public repository's current existing releases.
+
+ GithubRelease latestRelease = GithubReleases4J.getLatestRelease(
+ "Owner", "RepoName",
+ "Token" // OAuth token if it is a private repository.
+ ); // Get the latest release of the repository
+
+ if (latestRelease != null) {
+
+ List assets = latestRelease.getAssets();
+ // Get the Release' assets list
+
+ for (GithubAsset asset : assets) {
+ try {
+ asset.download(); // Download by the original file name.
+ } catch (IOException exception) {
+ exception.printStackTrace();
+ }
+
+ GithubUser uploader = asset.getUploader(); // Get the uploader of this asset.
+
+ }
+
+ GithubUser author = latestRelease.getAuthor(); // Get the author of this release.
+
+ }
+ }
+
+}