githubreleases4j's Introduction

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

README LANGUAGES [ ENGLISH | 中文 ]

GithubReleases4J

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 central repository-->
            <id>maven</id>
            <name>Maven Central</name>
            <url>https://repo1.maven.org/maven2</url>
        </repository>
      
        <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 {
  
    mavenCentral() // Using central repository.
  
    // Using github packages.
    maven { url 'https://maven.pkg.github.com/CarmJos/GithubReleases4J' }
}

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