From 9c74a3f85a179e3f7bf15072af44b81789955e9a Mon Sep 17 00:00:00 2001
From: rubenwardy <rw@rubenwardy.com>
Date: Sun, 10 Jan 2021 16:30:05 +0000
Subject: [PATCH] Update docs

---
 README.md | 30 +++++++++++++++++-------------
 1 file changed, 17 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 4015354..79c6d13 100644
--- a/README.md
+++ b/README.md
@@ -194,25 +194,29 @@ end
 	* `name` is the player name
 	* `def` is the award def.
 	* return true to cancel HUD
-* `awards.unlock(player_name, award)`
+* `awards.unlock(player_name, award_name)`
 	* gives an award to a player
 * `awards.get_award_states(player_name)`
 	* Returns list of tables, sorted by `score`, each having the fields:
 
-			{
-				name     = "mymod:awardname",
-				def      = {}, -- Award definition
-				unlocked = true, -- Whether award has been unlocked
-				started  = true, -- Whether any progress has been made
-				score    = 0, -- Score used in sorting
+		```lua
+		{
+			name     = "mymod:awardname",
+			def      = {}, -- Award definition
+			unlocked = true, -- Whether award has been unlocked
+			started  = true, -- Whether any progress has been made
+			score    = 0, -- Score used in sorting
 
-				-- Either a table or nil
-				progress = {
-					current = 5,
-					target  = 10,
-					label   = "label", -- Label to show over progress bar
-				}
+			-- Either a table or nil
+			-- Will be nil if progress is indeterminable or
+			-- if the award is unlocked
+			progress = {
+				current = 5,
+				target  = 10,
+				label   = "label", -- Label to show over progress bar
 			}
+		}
+		```
 
 ## Triggers