add (unfinished) readme
This commit is contained in:
parent
3f35fd34a6
commit
36da871fd9
1 changed files with 18 additions and 0 deletions
18
README.md
18
README.md
|
@ -0,0 +1,18 @@
|
|||
# ServerSeeker.py
|
||||
an easy to use python library for ServerSeeker
|
||||
|
||||
# Usage:
|
||||
|
||||
```py
|
||||
from serverseeker import ServerSeeker
|
||||
|
||||
skr = ServerSeeker(api_key="[Your api key goes here]")
|
||||
|
||||
# get details about your account, including limits
|
||||
skr.user_info()
|
||||
|
||||
|
||||
# search for servers
|
||||
skr.servers(country_code="PL", max_players=10)
|
||||
|
||||
```
|
Reference in a new issue