sheppy/open-web-leaderboard
1
0
Fork 0
mirror of https://github.com/FAUSheppy/open-web-leaderboard.git synced 2025-12-06 07:01:36 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

add readme

Browse Source
This commit is contained in:
Johnathen Sheppard
2019-06-09 16:55:36 +02:00
parent 07fe8fed62
commit e67f4debb5
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md Normal file
View File

@@ -0,0 +1,14 @@
# Open Web Leaderboard
The Open Web Leaderboard is a leaderboard that can easily be used with any backend as long as you find a way to supply the following information:
- 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
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.
# Preview
![open-web-leaderboard](https://media.atlantishq.de/leaderboard-github-picture.png)
# Live Demo
[rating.atlantishq.de](https://rating.atlantishq.de)