README

= php-leaderboard

Leaderboards backed by Redis in PHP, http://redis.io.

Builds off ideas proposed in http://blog.agoragames.com/2011/01/01/creating-high-score-tables-leaderboards-using-redis/.

== Usage

For now, look at the Ruby leaderboard documentation, https://github.com/agoragames/leaderboard, or the tests for usage.

== Ports

The following ports have been made of the leaderboard gem.

* Java: https://github.com/agoragames/java-leaderboard
* NodeJS: https://github.com/omork/node-leaderboard
* Python: https://github.com/agoragames/python-leaderboard
* Ruby: https://github.com/agoragames/leaderboard
* Scala: https://github.com/agoragames/scala-leaderboard

== Contributing to php-leaderboard
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the version or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

== Copyright

Copyright (c) 2011 David Czarnecki. See LICENSE.txt for further details.