Commits

Jacob Perkins committed f37cda5

contributing

Comments (0)

Files changed (1)

-A synchronous [[http://www.erlang.org/|erlang]] client application for [[http://code.google.com/p/redis/|redis]]. Read more at [[http://streamhacker.com/2009/12/21/erldis-erlang-redis-client/|streamhacker.com]].
+== About ==
+
+A synchronous [[http://www.erlang.org/|erlang]] client application for [[http://code.google.com/p/redis/|redis]]. You can read my introduction here: [[http://streamhacker.com/2009/12/21/erldis-erlang-redis-client/|erldis - an Erlang Redis client]].
 
 Keys and values are always converted to [[http://www.erlang.org/doc/reference_manual/data_types.html#id2252522|binaries]] for higher performance redis communication, thanks to [[http://cestari.wordpress.com/|Eric Cestari's]] high performance binaries [[http://github.com/cstar/erldis/tree/binaries|fork on github]]. Returned values will either be numbers, binaries, or the atoms //ok//, //nil//, //true//, //false//.
 
-For example usage, see the stdlib emulation modules:
+For immediate commit notifications, [[http://twitter.com/japerk|follow japerk on twitter]].
+
+== Example Usage ==
+
+See the stdlib emulation modules:
 * [[http://bitbucket.org/japerk/erldis/src/tip/src/erldis_dict.erl|erldis_dict]]
 * [[http://bitbucket.org/japerk/erldis/src/tip/src/erldis_list.erl|erldis_list]]
 * [[http://bitbucket.org/japerk/erldis/src/tip/src/erldis_sets.erl|erldis_sets]]
 
 Also checkout Eric's [[http://cestari.wordpress.com/2009/12/27/riak_redis_backend-thoughts/|riak redis backend article]] and [[http://github.com/cstar/riak_redis_backend|code]] to see erldis usage in the wild.
 
-Follow me on [[http://twitter.com/japerk|twitter]] for immediate commit notifications.
+== Contributing ==
+
+Contributing instructions are [[http://contributing.appspot.com/erldis|here]], but since you're already on bitbucket, the best way to contribute is to [[http://bitbucket.org/japerk/erldis/fork/|fork]] and send a pull request.