Skip to content

Commit 2dffb08

Browse files
committed
Add some headers to README
1 parent a302f12 commit 2dffb08

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![CodeFactor](https://www.codefactor.io/repository/github/pybotdevs/skyblockpy/badge)](https://www.codefactor.io/repository/github/pybotdevs/skyblockpy)
44

55

6+
## About
67
### What is SkyblockPy?
78
SkyblockPy is a simple Python API wrapper which is used to communicate and fetch data from the Hypixel Skyblock API endpoints.
89
It is based on the Python requests library, which makes it very simple to develop for and fix issues.
@@ -12,12 +13,10 @@ SkyblockPy works by communicating with the Hypixel API endpoints by using your *
1213

1314
If no errors are returned by the API endpoint (status code 200 is returned), then the API output is returned as a `dict`.
1415

16+
## Setup and Usage
1517
### Obtaining an API key
1618
Go to the Hypixel Minecraft Java server and use `/api` command.
1719

18-
### I found a bug/I want to add a missing feature!
19-
Just make a new issue [here](https://github.com/PyBotDevs/skyblockpy/issues/new) and describe the bug/feature.
20-
2120
### Example Implementation of SkyblockPy
2221
Here's an example snippet of retrieving the third page of the latest Skyblock auctions.
2322

@@ -33,6 +32,10 @@ def latest_auctions_raw() -> dict: # Make a function for returning API output,
3332
latest_auctions_raw() # Run the actual function now.
3433
```
3534

35+
## Extra
36+
### I found a bug/I want to add a missing feature!
37+
Just make a new issue [here](https://github.com/PyBotDevs/skyblockpy/issues/new) and describe the bug/feature.
38+
3639
<hr>
3740

3841
### Hypixel API Documentation is given here: https://api.hypixel.net/

0 commit comments

Comments
 (0)