clarify findPlayer function in readme

This commit is contained in:
Yannik Schmidt
2020-06-17 11:09:05 +02:00
parent a14438c1f7
commit 00852a0eec

View File

@@ -3,7 +3,7 @@ The Open Web Leaderboard is a leaderboard that can easily be used with any backe
- getRankRange(start, end) -> return a list of players from start rank to end rank
- getMaxEntries() -> return the total number of entries in the leaderboard
- findPlayer() -> find a player by name
- findPlayer() -> find a player by name and return a (player, rank)-tupel
The system was developed to be used with the [skillbird-framwork](https://github.com/FAUSheppy/skillbird). If you use this framework, the program should be working without any arguments. If you need more conductibility feel free to open a pull-request or send me a message.