Skip to content

Commit 6c4dc83

Browse files
committed
Update README.md
1 parent 20d8450 commit 6c4dc83

File tree

1 file changed

+35
-12
lines changed

1 file changed

+35
-12
lines changed

README.md

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,64 @@
11
Hypixel Public API (Java)
22
======
3-
This is a Java implementation of the Hypixel API. For discussing the API, requesting help or suggestions you can use the GitHub [Discussions](https://github.com/HypixelDev/PublicAPI/discussions).
3+
This is a Java implementation of the Hypixel API. For discussing the API, requesting help or suggestions you can use the
4+
GitHub [Discussions](https://github.com/HypixelDev/PublicAPI/discussions).
45

56
### Documentation
6-
Hypixel PublicAPI documentation can be found in the [Documentation](https://github.com/HypixelDev/PublicAPI/tree/master/Documentation).
7-
Java documentation can be found in the code.
7+
8+
Hypixel Public API documentation can be found in
9+
the [Documentation](https://github.com/HypixelDev/PublicAPI/tree/master/Documentation). Java documentation can be found
10+
in the code.
11+
12+
### GitHub Issues
13+
14+
Github issues should only be used to report bugs and for detailed feature requests. Everything else should either be in
15+
Github discussions or use the Hypixel [Code Creations](https://hypixel.net/forums/code-creations.65/) forum.
816

917
### Usage
18+
1019
You can use this API as a dependency via the public Hypixel maven repo.
1120

1221
```xml
22+
1323
<repository>
1424
<id>Hypixel</id>
1525
<url>https://repo.hypixel.net/repository/Hypixel/</url>
1626
</repository>
1727
```
1828

1929
```xml
30+
2031
<dependency>
2132
<groupId>net.hypixel</groupId>
2233
<artifactId>HypixelAPI</artifactId>
2334
<version>3.0.0</version>
2435
</dependency>
2536
```
2637

38+
### Dependencies
39+
40+
The Hypixel PublicAPI has the following dependencies:
41+
42+
* Google Gson library
43+
* Apache HttpClient
44+
2745
### Query Limitations
28-
The API server has a request limit of 120 queries per minute. Any abuse of the API or intentions to bypass this limit (such as with multiple API keys) will lead to your API key being reset or banned.
2946

30-
If you require a higher limit than the above you can open a support ticket at https://support.hypixel.net and provide your use case and why you require a higher limit.
47+
The API server has a request limit of 120 queries per minute. Any abuse of the API or intentions to bypass this limit (
48+
such as with multiple API keys) will lead to your API key being reset or banned.
49+
50+
If you require a higher limit than the above you can open a support ticket at https://support.hypixel.net and provide
51+
your use case and why you require a higher limit.
3152

3253
### Obtaining an API Key
33-
You can obtain an API key by joining ```mc.hypixel.net``` with a valid Minecraft account and running the /api command. You will then be assigned a unique key that is to remain **private**.
3454

35-
### Dependencies
36-
The Hypixel PublicAPI has the following dependencies:
37-
* Google Gson library
38-
* Apache HttpClient
55+
You can obtain an API key by joining ```mc.hypixel.net``` with a valid Minecraft account and running the /api command.
56+
You will then be assigned a unique key that is to remain **private**.
57+
58+
### Contributing
59+
60+
When contributing changes to the Java API please provide as much detail on the changes and the reasons for them. We will
61+
not accept changes that have no meaningful contribution to the project.
3962

40-
### Bug Reporting
41-
You can create an issue here on GitHub to report a bug with the API or to suggest enhancements.
63+
We are currently in the process of migrating the API documentation and due to this we will not be accepting changes to
64+
the current documentation on this Github repo.

0 commit comments

Comments
 (0)