README -> README.md

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f16b34
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+python-gamelocker
+===
+
+[Private mirror](https://git.schneefux.xyz/schneefux/python-gamelocker) [GitHub mirror](https://github.com/schneefux/python-gamelocker)
+
+Python 3 wrapper for the Gamelocker API. Currently supports [Vainglory](https://developers.vainglorygame.com). Install with PyPi: `pip install python-gamelocker`.
+
+[Private docs mirror](https://docs.schneefux.xyz/python-gamelocker) [GitHub docs mirror](https://schneefux.github.io/python-gamelocker)
+
+Example usage:
+```python
+>>> import gamelocker
+>>> APIKEY = "aaa.bbb.ccc"
+>>> api = gamelocker.Gamelocker(APIKEY).Vainglory()
+>>> m = api.matches(limit=2, player="TheLegend27")
+>>> m
+[<gamelocker.datatypes.Match object at 0x7f2682314ac8>, <gamelocker.datatypes.Match object at 0x7f26823d3c50>]
+>>> m.rosters[0].participants[0].player.name
+"iiDruid"
+>>> m.rosters[0].participants[0].stats.kills
+10
+>>> m.rosters[0].stats.acesEarned
+2
+```