Permalink
Browse files

updated README

  • Loading branch information...
1 parent 19cb72f commit a8720749ace6ddd969eeeab42ca57b55a5d88519 @brosner brosner committed Apr 14, 2010
Showing with 18 additions and 1 deletion.
  1. +18 −1 README
View
19 README
@@ -1 +1,18 @@
-Points, positions and levels oh my!
+===========
+agon README
+===========
+
+agon provides the ability to track points on arbitrary objects in your system.
+The common case being ``User`` instances. It can additionally keep track of
+positions for these objects to produce leaderboards.
+
+This code has mostly been pulled out of `typewar`_ and made slightly more
+generic to work well.
+
+.. _typewar: http://typewar.com/
+
+
+Requirements
+============
+
+This app requires the use of Django 1.1+.

0 comments on commit a872074

Please sign in to comment.