More readme.

This commit is contained in:
Greg Edwards 2014-09-17 11:33:18 -04:00
parent 60d491174f
commit f20bd49629

View File

@ -11,3 +11,16 @@ requests or new issues so I can verify your fix.
Since I have not yet settled on a license, please ask before using this in your
project. I can be contacted at #altwfc in Rizon.
##Usage
In general, you'll want to perform URL rewriting in your global.asax handler to
forward requests to the .ashx file where you implement your gamestats logic. In
the .ashx handler, instead of inheriting IHttpHandler, you will inherit from
GamestatsBase.GamestatsHandler and add a constructor where you provide the
game-specific secret constants. (These constants will be contained within the
game binary and helping you find them is outside the scope of this project.)
Please see the included (albeit incomplete) Tetris DS example and the more
robust [Pokémon Foundations](https://github.com/mm201/pkmnFoundations) project
for examples of this library in use.