1
mirror of https://github.com/CarmJos/GithubReleases4J.git synced 2024-09-19 13:45:45 +00:00
GitHub Releases for Java , based on GitHub RESTful API .
Go to file
2022-02-07 20:04:46 +08:00
.documentation [v1.2.0] 补充Javadoc 2022-01-22 05:37:54 +08:00
.github 修改构建名 2022-02-07 03:04:40 +08:00
src 修改示例代码 2022-01-24 17:40:31 +08:00
.gitignore 项目初始化 2022-01-22 02:32:04 +08:00
LICENSE 项目初始化 2022-01-22 02:32:04 +08:00
pom.xml 修改构建名 2022-02-07 03:05:09 +08:00
README_zh_CN.md Update README_zh_CN.md 2022-02-07 20:04:46 +08:00
README.md [v1.3.0] [A] Add update checker demo. 2022-01-22 15:26:44 +08:00

  _____ _ _   _           _     _____      _                          _  _       _ 
 / ____(_) | | |         | |   |  __ \    | |                        | || |     | |
| |  __ _| |_| |__  _   _| |__ | |__) |___| | ___  __ _ ___  ___  ___| || |_    | |
| | |_ | | __| '_ \| | | | '_ \|  _  // _ \ |/ _ \/ _` / __|/ _ \/ __|__   _|   | |
| |__| | | |_| | | | |_| | |_) | | \ \  __/ |  __/ (_| \__ \  __/\__ \  | || |__| |
 \_____|_|\__|_| |_|\__,_|_.__/|_|  \_\___|_|\___|\__,_|___/\___||___/  |_| \____/ 
                                                

README LANGUAGES [ ENGLISH | 中文 ]

GithubReleases4J

version License workflow CodeSize Support

GitHub Releases for Java , based on GitHub REST API .

To provide an easy way to fetch updates and download assets.

Functions

  • 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
  • Update check methods. (See demo)

Dependency Usage

Maven dependency

<project>
    <repositories>
        <repository>
            <!--Using github packages-->
            <id>GithubReleases4J</id>
            <name>GitHub Packages</name>
            <url>https://maven.pkg.github.com/CarmJos/GithubReleases4J</url>
        </repository>
    </repositories>

    <dependencies>
        <dependency>
            <groupId>cc.carm.lib</groupId>
            <artifactId>githubreleases4j</artifactId>
            <version>[LATEST RELEASE]</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

</project>
Gradle dependency
repositories {
    // Using github packages.
    maven { url 'https://maven.pkg.github.com/CarmJos/GithubReleases4J' }
}

dependencies {
    api "cc.carm.lib:githubreleases4j:[LATEST RELEASE]"
}

DEMO Code

Please click here to read the demo codes.

Open Source License.

The project using The MIT License .