Skip to content

Commit b77806f

Browse files
authored
Add more documentation to README
1 parent f3458e6 commit b77806f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,13 @@ SkyblockPy is a simple Python API wrapper which is used to communicate and fetch
66
It is based on the Python requests library, which makes it very simple to develop for and fix issues.
77

88
### How do I use SkyblockPy?
9-
SkyblockPy works by communicating with the Hypixel API endpoints by using your **API key**.
9+
SkyblockPy works by communicating with the Hypixel API endpoints by using your **API key**.
10+
11+
If no errors are returned by the API endpoint (status code 200 is returned), then the API output is returned as a `dict`.
12+
13+
### I found a bug/I want to add a missing feature!
14+
Just make a new issue [here](https://github.com/PyBotDevs/skyblockpy/issues/new) and describe the bug/feature.
15+
16+
<hr>
17+
18+
### Hypixel API Documentation is given here: https://api.hypixel.net/#section/Introduction

0 commit comments

Comments
 (0)