search

Top-gg-Community / java-sdk

An API wrapper for https://top.gg/api/docs that works in Java
Apache License 2.0
36 stars 22 forks source link

Incorrect/Misleading Maven Dependency Info #2

Closed SirSkaro closed 6 years ago

SirSkaro commented 6 years ago

The README.md has the incorrect info to include this library into a Maven project. The current README specifies this:

<dependencies>
    <dependency>
        <groupId>com.github.DiscordBotList</groupId>
        <artifactId>DBL-Java-Wrapper</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>

However, jitpack.io specifies the artifact ID as DBL-Java-Library. In addition, it is unclear what the current version of the library is. The version is not specified in the README, but is only specified in build.gradle. But this is misleading, as jitpack.io specifies that there is a "v" prepended to the version. The dependency info is as follows:

<dependency>
   <groupId>com.github.DiscordBotList</groupId>
      <artifactId>DBL-Java-Library</artifactId>
   <version>v1.0</version>
</dependency>
nikammerlaan commented 6 years ago

The v1.0 comes from the GitHub releases. You can either input one of those or a commit hash in place of it. I do admit the version in the build.gradle is confusing -- that can be removed completely.

The artifact id change is because the repo has been renamed without informing me, so I never got a chance to update it here as well. I'll push an update with these changes in a minute.