1 files changed, 35 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..965281f
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,35 @@
+Awards
+------
+
+by Andrew "Rubenwardy" Ward, CC-BY-SA.
+
+This mod adds achievements to Minetest.
+
+
+Code Reference
+--------------
+
+The API
+=======
+* awards.register_achievement(name,data_table)
+	* name
+	* desciption
+	* sound [optional]
+	* image [optional]
+	* func [optional] - see below
+* awards.register_onDig(data_table)
+	* award
+	* func
+		* return true if the medal should be rewarded
+
+
+Player Data
+===========
+
+A list of data referenced/hashed by the player's name.
+
+* name [string]
+* getNodeCount('node_name') [function]
+* count [table]
+	* modname [table]
+		*itemname [int]
+\ No newline at end of file