summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrubenwardy <rw@rubenwardy.com>2018-08-22 15:19:38 +0100
committerGitHub <noreply@github.com>2018-08-22 15:19:38 +0100
commit570fd3a206ecc2c0573f25cb8d4b0b4d0e5b7e8d (patch)
treeb8f042e76359cd3d8486353a833b0eaee0920cae
parent417ac0fe46827b10c57c27e0d9da93b7a61c0836 (diff)
Fix incorrect `description` documentation
-rw-r--r--README.md22
1 files changed, 1 insertions, 21 deletions
diff --git a/README.md b/README.md
index c516384..26ca57c 100644
--- a/README.md
+++ b/README.md
@@ -8,25 +8,6 @@ With thanks to Wuzzy, kaeza, and MrIbby.
Majority of awards are back ported from Calinou's old fork in Carbone, under same license.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
# Introduction
## Awards and Triggers
@@ -189,7 +170,7 @@ end
* awards.register_award(name, def), the def table has the following fields:
* `title` - title of the award (defaults to name)
- * `description` - the title of the award. Required.
+ * `description` - longer description of the award, displayed in Awards tab
* `difficulty` - see [Award Difficulty](#award-difficulty).
* `requires` - list of awards that need to be unlocked before this one
is visible.
@@ -201,7 +182,6 @@ end
* `background` - the background image, use default otherwise.
* `trigger` - trigger definition, see [Builtin Trigger Types](#builtin-trigger-types).
* `on_unlock(name, def)` - callback on unlock.
-
* awards.register_trigger(name, def), the def table has the following fields:
* `type` - see [Trigger Types](#trigger-types).
* `progress` - used to format progress, defaults to "%1/%2".