Permalink
Browse files

Clean up; add defaults settings; add README; add LICENSE.

  • Loading branch information...
1 parent bfb75e3 commit 1d82856c43310840fa98a11d680f323089852d0e Armando Di Cianno committed Aug 5, 2011
Showing with 78 additions and 3 deletions.
  1. +20 −0 LICENSE.txt
  2. +49 −1 README
  3. +9 −2 src/leaderboard.app.src
View
@@ -0,0 +1,20 @@
+Copyright (c) 2011 Armando Di Cianno
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
50 README
@@ -1 +1,49 @@
-YES, THIS IS A README
+= erlang-leaderboard
+
+A leaderboard system in Erlang and backed by Redis - http://redis.io
+
+'erlang-leaderboard' is an erlang implementation of @czarneckid 's 'leaderboard' gem written in Ruby - https://github.com/agoragames/leaderboard
+
+== Installation
+
+Install Erlang. http://www.erlang.org/
+
+Install rebar. You can acquire and build it thusly:
+
+ git clone git://github.com/basho/rebar.git
+ cd rebar
+ ./bootstrap
+ cp rebar /usr/local/bin
+
+Acquire and build the erlang-leaderboard sources. It will fetch cstar's version of erldis automatically, as an internal depenendency. https://github.com/cstar/erldis
+
+ git clone git://github.com/agoragames/erlang-leaderboard.git
+ cd erlang-leaderboard
+ rebar compile
+ # Possibly edit files in ./rel/files/* to your liking, if you so desire
+ rebar generate
+
+Make sure that redis is running.
+
+TODO - Add info about how to easily start the gen_server (once it works reliably!)
+
+== Compatibility
+
+This software has been built and tested with Erlang/OTP R14B03.
+
+== Usage
+
+TODO
+
+== Performance
+
+TODO
+
+== Future Ideas
+
+TODO
+
+== Copyright
+
+Copyright (c) 2011 Armando Di Cianno. See LICENSE.txt for further details.
+
View
@@ -1,12 +1,19 @@
{application, leaderboard,
[
{description, "Redis-backed leaderboard server"},
- {vsn, "0.0.1"},
+ {vsn, "1.0.0"},
{registered, []},
{applications, [
kernel,
stdlib,
sasl
]},
- {mod, {leaderboard_app, []}}
+ {mod, {leaderboard_app, []}},
+ {env, [{host, "127.0.0.1"},
+ {port, 6379},
+ {with_scores, true},
+ {with_rank, true},
+ {zero_index_for_rank, false},
+ {page_size, 25}
+ ]}
]}.

0 comments on commit 1d82856

Please sign in to comment.