Skip to content

Commit b3dd624

Browse files
committed
Lots of changes
- Finished up build.gradle (hopefully) - Tons of corrections to Javadoc comments - Simplified some methods
1 parent f0125ac commit b3dd624

File tree

100 files changed

+44738
-2384
lines changed

Some content is hidden

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

100 files changed

+44738
-2384
lines changed

.all-contributorsrc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,16 @@
7777
"contributions": [
7878
"plugin"
7979
]
80+
},
81+
{
82+
"login": "cjbrooks12",
83+
"name": "Casey Brooks",
84+
"avatar_url": "https://avatars2.githubusercontent.com/u/6157866?v=4",
85+
"profile": "https://www.caseyjbrooks.com/",
86+
"contributions": [
87+
"code",
88+
"doc"
89+
]
8090
}
8191
],
8292
"contributorsPerLine": 7,

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ assignees: ''
88
---
99

1010
## Checks
11-
Please check the below options to confirm that you did those steps first!
12-
Bug Reports not having these steps checked will be ignored and closed.
11+
> Please check the below options to confirm that you did those steps first!
12+
> Bug Reports not having these steps checked will be ignored and closed.
13+
>
1314
- [ ] You use the correct version of JavaBotBlockAPI for your Bot.
14-
Fot JDA v3 you have to use Version 1.0.5
15+
For JDA v3 you have to use Version 1.0.5
1516
- [ ] There is no other issue open with the same or similar bug reported.
16-
- [ ] The bug is not caused by any 3rd party library (f.e. JDA) or the BotBlock API itself.
17+
- [ ] The bug isn't caused by any 3rd party library (f.e. JDA) or the BotBlock API itself.
1718

1819
## Bug
1920
> What bug did you encounter? Try to describe it as detailed as possible.
2021
> Provide Errors and code-snippets through sites like https://hasteb.in
2122
<!-- Please write below this line to not have any formatting issues. -->
2223
24+
2325
## Steps to replicate
2426
> Please listen the steps you did to encounter this bug.
25-
<!-- Please write below this line to not have any formatting issues. -->
27+
2628
1.
2729
2.
2830
3.
2931

3032
## Additional information
31-
> Provide any additional informations like:
32-
> - JDA version (if used)
33-
> - Java version
34-
> - Additional (3rd party) libraries
35-
> - Images to show the problem.
36-
<!-- Please write below this line to not have any formatting issues. -->
33+
> Provide the requested information below:
34+
35+
- **Used Modules**: `i.e. core, jda-module, request-module`
36+
- **Java version**: `i.e. Java 8`

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,24 @@ assignees: ''
88
---
99

1010
## Checks
11-
Please check the below options to confirm that you did those steps first!
12-
Feature requests not having these steps checked will be ignored and closed.
11+
> Please check the below options to confirm that you did those steps first!
12+
> Feature requests not having these steps checked will be ignored and closed.
13+
>
1314
- [ ] You use the correct version of JavaBotBlockAPI for your bot.
1415
For JDA v3 you have to use Version 1.0.5. There won't be new features added to older versions!
1516
- [ ] There is no other issue open with the same or similar Feature request,
16-
- [ ] The feature is not related to JDA or any other 3rd party library or the BotBlock API.
17+
- [ ] The feature isn't related to JDA or any other 3rd party library or the BotBlock API.
1718

1819
## Feature Request
1920
> What new feature or what improvement should be added?
2021
> If you have code snippets to share, do that through https://hasteb.in
2122
<!-- Please write below this line to prevent formatting issues. -->
2223
24+
2325
## Why adding this?
2426
> Why should this be added? What are the benefits of adding this?
2527
<!-- Please write below this line to prevent formatting issues. -->
2628
29+
2730
## Additional information
28-
> Add any additional pieces of information like links, screenshots, etc.
31+
> Add any additional pieces of information like links, screenshots, targeted module(s), etc.

.github/workflows/build_docs.yml

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

README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,37 @@
1-
<!-- BotBlock links -->
2-
[BotBlock]: https://botblock.org
1+
[BotBlock]: https://botblock.org
32
[API]: https://botblock.org/api/docs
43

5-
<!-- BotBlock4J -->
64
[BotBlock4J]: https://github.com/Nathan-webb/BotBlock4J
75

8-
<!-- Javadoc link -->
96
[wiki]: https://jbba.dev/docs
107

11-
<!-- CI link (Thanks to CodeMC.io) -->
12-
[CodeMC]: https://ci.codemc.io/job/botblock/job/JavaBotBlockAPI/
8+
[CodeMC]: https://ci.codemc.io/job/botblock/job/JavaBotBlockAPI/
139
[CodeMCBadge]: https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.codemc.io%2Fjob%2Fbotblock%2Fjob%2FJavaBotBlockAPI%2F&label=Dev%20Builds&style=plastic
1410

15-
<!-- Bintray links -->
16-
[BadgeDownload]: https://img.shields.io/bintray/v/andre601/maven/JavaBotBlockAPI?label=Bintray&style=plastic
11+
[BadgeDownload]: https://img.shields.io/bintray/v/andre601/maven/JavaBotBlockAPI?label=Bintray&style=plastic
1712
[Download]: https://bintray.com/andre601/maven/JavaBotBlockAPI/_latestVersion
1813

19-
<!-- JavaBotBlockAPI image -->
20-
[image]: src/main/resources/JavaBotBlockAPI.png
14+
[JDA]: https://github.com/DV8FromTheWorld/JDA
15+
[OkHttp]: https://github.com/square/okhttp/
16+
[JSON]: https://github.com/stleary/JSON-java
17+
[Caffeine]: https://github.com/ben-manes/caffeine
2118

22-
<!-- Dependency links -->
23-
[JDA]: https://github.com/DV8FromTheWorld/JDA
24-
[OkHttp]: https://github.com/square/okhttp/
25-
[JSON]: https://github.com/stleary/JSON-java
26-
[Caffeine]: https://github.com/ben-manes/caffeine
27-
28-
<!-- GitHub links -->
29-
[Wiki]: https://github.com/botblock/JavaBotBlockAPI/wiki
19+
[Wiki]: https://github.com/botblock/JavaBotBlockAPI/wiki
3020
[contributors.md]: https://github.com/botblock/JavaBotBlockAPI/blob/master/contributors.md
3121

32-
![image]
3322

3423
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.
3524
This wrapper is a fork of [BotBlock4J] and was updated and improved to make it as userfriendly as possible.
3625

3726
# Installation
38-
[![BadgeDownload]][Download] [![CodeMCBadge]][CodeMC]
27+
[![BadgeDownload]](https://bintray.com/andre601/maven/JavaBotBlockAPI/_latestVersion) [![CodeMCBadge]](https://ci.codemc.io/job/botblock/job/JavaBotBlockAPI/)
3928

4029
You can install JavaBotBlockAPI through the following methods.
4130
Make sure to replace `{version}` with the above shown version.
4231

4332
## Gradle
4433
Put this code into your `build.gradle`:
45-
```gradle
34+
```groovy
4635
repositories{
4736
jcenter()
4837
}
@@ -84,6 +73,6 @@ Here are some useful links:
8473
- [CodeMC] CI server for dev builds. Those jar files may differ from the ones on bintray.
8574
- [BotBlock4J] Original Wrapper from which this one originates.
8675

87-
## Contributors
76+
## Contributors
8877
We appreciate any contribution from others towards this project.
8978
All contributors are listed on the [contributors.md] file.

SECURITY.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,32 @@
44
# Security Policy
55

66
## Supported Versions
7-
We only support the latest major version and only make updates towards those.
7+
We only support the latest major releases of the different modules, which are listed below.
8+
Those are also the only versions that may receive bug fixes and patches.
9+
10+
### Core
11+
12+
| Version | Supported |
13+
| ------- | ------------------ |
14+
| 5.x | :white_check_mark: |
15+
| 4.x | :x: |
16+
| 3.x | :x: |
17+
| 2.x | :x: |
18+
| 1.x | :x: |
19+
20+
----
21+
### JDA-Module
22+
23+
| Version | Supported |
24+
| ------- | ------------------ |
25+
| 5.x | :white_check_mark: |
26+
| 4.x | :x: |
27+
| 3.x | :x: |
28+
| 2.x | :x: |
29+
| 1.x | :x: |
30+
31+
----
32+
### Request-Module
833

934
| Version | Supported |
1035
| ------- | ------------------ |
@@ -14,6 +39,7 @@ We only support the latest major version and only make updates towards those.
1439
| 2.x | :x: |
1540
| 1.x | :x: |
1641

42+
---
1743
## Reporting a Vulnerability
1844

1945
Please report any security issues on the [Discord Server][discord].

0 commit comments

Comments
 (0)