Skip to content

Commit 062a7b4

Browse files
Andre601Andre601
authored
Update and rename index.html to index.md
1 parent 998c305 commit 062a7b4

2 files changed

Lines changed: 75 additions & 133 deletions

File tree

‎docs/index.html‎

Lines changed: 0 additions & 133 deletions
This file was deleted.

‎docs/index.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# JavaBotBlockAPI
2+
A Java Wrapper for the BotBlock.org API, supporting all API endpoints of it.
3+
4+
## Javadocs
5+
Below can you find Javadocs for each module.
6+
7+
- [Core](https://docs.botblock.org/JavaBotBlockAPI/core/)
8+
- [Javacord](https://docs.botblock.org/JavaBotBlockAPI/javacord/org/botblock/javabotblockapi/javacord/package-summary.html)
9+
- [JDA](https://docs.botblock.org/JavaBotBlockAPI/jda/org/botblock/javabotblockapi/jda/package-summary.html)
10+
- [Request](https://docs.botblock.org/JavaBotBlockAPI/request/org/botblock/javabotblockapi/requests/package-summary.html)
11+
12+
## Installation
13+
Please replace `{version}` with the latest build available on [CodeMC](https://ci.codemc.io/job/botblock/job/JavaBotBlockAPI/).
14+
15+
### Gradle
16+
```groovy
17+
repositories{
18+
maven{ url = 'https://repo.codemc.io/repository/maven-public' }
19+
}
20+
21+
dependencies{
22+
// The Core and Request modules are always required.
23+
compile group: 'org.botblock', name: 'javabotblockapi-core', version: '{version}'
24+
compile group: 'org.botblock', name: 'javabotblockapi-request', version: '{version}'
25+
26+
// Javacord module for direct support with Javacord.
27+
compile group: 'org.botblock', name: 'javabotblockapi-javacord', version: '{version}'
28+
29+
// JDA module for direct support with JDA.
30+
compile group: 'org.botblock', name: 'javabotblockapi-jda', version: '{version}'
31+
}
32+
```
33+
34+
### Maven
35+
```xml
36+
<repositories>
37+
<repository>
38+
<id>codemc</id>
39+
<url>https://repo.codemc.io/repository/maven-public/</url>
40+
</repository>
41+
</repositories>
42+
43+
<dependencies>
44+
<!-- The Core module is always required. -->
45+
<dependency>
46+
<groupId>org.botblock</groupId>
47+
<artifactId>javabotblockapi-core</artifactId>
48+
<version>{version}</version>
49+
</dependency>
50+
<!-- The Request module is always required. -->
51+
<dependency>
52+
<groupId>org.botblock</groupId>
53+
<artifactId>javabotblockapi-request</artifactId>
54+
<version>{version}</version>
55+
</dependency>
56+
<!-- Javacord module for direct support with Javacord. -->
57+
<dependency>
58+
<groupId>org.botblock</groupId>
59+
<artifactId>javabotblockapi-javacord</artifactId>
60+
<version>{version}</version>
61+
</dependency>
62+
<!-- JDA module for direct support with JDA. -->
63+
<dependency>
64+
<groupId>org.botblock</groupId>
65+
<artifactId>javabotblockapi-jda</artifactId>
66+
<version>{version}</version>
67+
</dependency>
68+
</dependencies>
69+
```
70+
71+
## Links
72+
73+
- [BotBlock Documentation](https://botblock.org/docs)
74+
- [BotBlock Discord](https://botblock.org/discord) (**Do NOT ask BotBlock-Staff for help with this API Wrapper**)
75+
- [Andre's Support Discord](https://discord.gg/6dazXp6) (Ask in the `#javabotblockapi` channel)

0 commit comments

Comments
 (0)