Skip to content

Commit 47faa18

Browse files
Andre601Andre601
committed
Update Readme and remove "-module" names
1 parent 40dddb8 commit 47faa18

File tree

146 files changed

+173
-112
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+173
-112
lines changed

‎README.md

Lines changed: 69 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,12 @@
1616
[JSON]: https://github.com/stleary/JSON-java
1717
[Caffeine]: https://github.com/ben-manes/caffeine
1818

19-
[Wiki]: https://github.com/botblock/JavaBotBlockAPI/wiki
2019
[contributors.md]: https://github.com/botblock/JavaBotBlockAPI/blob/master/contributors.md
2120

21+
[Javadoc]: https://docs.botblock.org/JavaBotBlockAPI
22+
[image]: https://docs.botblock.org/JavaBotBlockAPI/assets/img/JavaBotBlockAPI.png
23+
24+
![image]
2225

2326
JavaBotBlockAPI is a continued and updated Java Wrapper for [BotBlock], a website that makes it possible to update guild counts on multiple lists with one API.
2427
This wrapper is a fork of [BotBlock4J] and was updated and improved to make it as userfriendly as possible.
@@ -30,31 +33,89 @@ You can install JavaBotBlockAPI through the following methods.
3033
Make sure to replace `{version}` with the above shown version.
3134

3235
## Gradle
33-
Put this code into your `build.gradle`:
36+
Put this code into your `build.gradle` to download all modules:
37+
```groovy
38+
repositories{
39+
maven{ url = 'https://dl.bintray.com/andre601/maven' }
40+
}
41+
42+
dependencies{
43+
compile group: 'org.botblock', name: 'javabotblockapi', version: '{version}'
44+
}
45+
```
46+
47+
if you want to only download specific modules can you just use `javabotblockapi-<module>`:
3448
```groovy
3549
repositories{
36-
jcenter()
50+
maven{ url = 'https://dl.bintray.com/andre601/maven' }
3751
}
3852
3953
dependencies{
40-
compile group: 'org.botblock', name: 'JavaBotBlockAPI', version: '{version}'
54+
// Core Module. Always needed
55+
compile group: 'org.botblock', name: 'javabotblockapi-core', version: '{version}'
56+
57+
// Request Module. Depends on Core
58+
compile group: 'org.botblock', name: 'javabotblockapi-request', version: '{version}'
59+
60+
// JDA Module. Depends on Core and Request
61+
compile group: 'org.botblock', name: 'javabotblockapi-jda', version: '{version}'
4162
}
4263
```
4364

4465
## Maven
45-
For maven use this code snippet:
66+
For maven use this code snippet to download all modules:
67+
```xml
68+
<repositories>
69+
<repository>
70+
<id>jcenter</id>
71+
<url>https://dl.bintray.com/andre601/maven</url>
72+
</repository>
73+
</repositories>
74+
75+
<dependencies>
76+
<dependency>
77+
<groupId>org.botblock</groupId>
78+
<artifactId>javabotblockapi</artifactId>
79+
<version>{version}</version>
80+
</dependency>
81+
</dependencies>
82+
```
83+
84+
if you want to only download specific modules can you just use `javabotblockapi-<module>`:
4685
```xml
86+
<repositories>
87+
<repository>
88+
<id>jcenter</id>
89+
<url>https://dl.bintray.com/andre601/maven</url>
90+
</repository>
91+
</repositories>
92+
4793
<dependencies>
94+
<!-- Core Module. Always needed -->
95+
<dependency>
96+
<groupId>org.botblock</groupId>
97+
<artifactId>javabotblockapi-core</artifactId>
98+
<version>{version}</version>
99+
</dependency>
100+
101+
<!-- Request Module. Depends on Core -->
102+
<dependency>
103+
<groupId>org.botblock</groupId>
104+
<artifactId>javabotblockapi-request</artifactId>
105+
<version>{version}</version>
106+
</dependency>
107+
108+
<!-- JDA Module. Depends on Core and Request -->
48109
<dependency>
49110
<groupId>org.botblock</groupId>
50-
<artifactId>JavaBotBlockAPI</artifactId>
111+
<artifactId>javabotblockapi-jda</artifactId>
51112
<version>{version}</version>
52113
</dependency>
53114
</dependencies>
54115
```
55116

56117
# Usage
57-
Please visit the [wiki] for all available POST and GET methods, as the amount of GET methods alone is quite large.
118+
Please visit the [Javadoc] for all available POST and GET methods, as the amount of GET methods alone is quite large.
58119

59120
# Libraries/Dependencies
60121
JavaBotBlockAPI utilizes different APIs to provide the functionality it offers right now.
@@ -69,7 +130,7 @@ We have a list of those libraries listed here.
69130
Here are some useful links:
70131
- [BotBlock.org][BotBlock] Site for which this wrapper was made.
71132
- [API] API documentation.
72-
- [Wiki and Javadocs][wiki] Java documentation of the Wrapper.
133+
- [Javadoc] Java documentation of the Wrapper.
73134
- [CodeMC] CI server for dev builds. Those jar files may differ from the ones on bintray.
74135
- [BotBlock4J] Original Wrapper from which this one originates.
75136

‎docs/assets/img/JavaBotBlockAPI.png

55.2 KB
Loading

‎docs/assets/img/jbba.png

71.2 KB
Loading

‎docs/core/allclasses-index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 16:58:20 CEST 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 17:49:17 CEST 2020 -->
66
<title>All Classes (core 6.0.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2020-08-08">

‎docs/core/allclasses.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 16:58:20 CEST 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 17:49:17 CEST 2020 -->
66
<title>All Classes (core 6.0.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2020-08-08">

‎docs/core/allpackages-index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 16:58:20 CEST 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 17:49:17 CEST 2020 -->
66
<title>All Packages (core 6.0.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2020-08-08">

‎docs/core/constant-values.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 16:58:20 CEST 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 17:49:17 CEST 2020 -->
66
<title>Constant Field Values (core 6.0.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2020-08-08">

‎docs/core/deprecated-list.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 16:58:20 CEST 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 17:49:17 CEST 2020 -->
66
<title>Deprecated List (core 6.0.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2020-08-08">

‎docs/core/help-doc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 16:58:20 CEST 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 17:49:17 CEST 2020 -->
66
<title>API Help (core 6.0.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2020-08-08">

‎docs/core/index-all.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 16:58:20 CEST 2020 -->
5+
<!-- Generated by javadoc (11.0.4) on Sat Aug 08 17:49:17 CEST 2020 -->
66
<title>Index (core 6.0.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2020-08-08">

0 commit comments

Comments
 (0)