Skip to content

Commit

Permalink
GITBOOK-5: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
DxsSucuk authored and gitbook-bot committed Mar 4, 2023
1 parent 56a67a4 commit 8ee22ab
Showing 1 changed file with 27 additions and 6 deletions.
33 changes: 27 additions & 6 deletions doc/guide/setup.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Setup

## Requirements

Before starting you will need a API-Key from [Amari](https://docs.amaribot.com/api/api#authentication).

## How do Import this Library?

You can use [Jitpack](https://jitpack.io/#DxsSucuk/Amari4Java) to import it into your Maven or Gradle Project!
You can use [Jitpack](https://jitpack.io/#DxsSucuk/Amari4Java) to import it into your Project!

{% tabs %}
{% tab title="Maven" %}
Expand All @@ -12,7 +16,6 @@ You can use [Jitpack](https://jitpack.io/#DxsSucuk/Amari4Java) to import it into
<url>https://jitpack.io</url>
</repository>
...

<dependency>
<groupId>com.github.DxsSucuk</groupId>
<artifactId>Amari4Java</artifactId>
Expand All @@ -23,20 +26,38 @@ You can use [Jitpack](https://jitpack.io/#DxsSucuk/Amari4Java) to import it into
{% endtab %}

{% tab title="Gradle" %}
<pre class="language-gradle"><code class="lang-gradle">allprojects {
repositories {
...
<strong> maven { url 'https://jitpack.io' }
<pre class="language-gradle"><code class="lang-gradle"><strong>allprojects {
</strong> repositories {
...
<strong> maven { url 'https://jitpack.io' }
</strong> }
}
...
dependencies {
...
implementation 'com.github.DxsSucuk:Amari4Java:<a data-footnote-ref href="#user-content-fn-2">Tag</a>'
}
</code></pre>
{% endtab %}
{% endtabs %}

## How do I use it?

You will need to create a new Instance of the Amari4J class!

```java
Amari4J amari4j = new Amari4J("YOUR KEY");
```

After doing that you can simply call the method you need!\
For example to get the weekly Leaderboard of a Guild you can do this:

```java
amari4j.getWeekylLeaderboard("guildId");
```



[^1]: Replace this with the version you want to use!

[^2]: Replace this with the version you want to use!

0 comments on commit 8ee22ab

Please sign in to comment.