nalc
/
awards
forked from mtcontrib/awards
1
0
Fork 1
Code Issues Pull Requests Releases Wiki Activity

Fix incorrect `description` documentation

This commit is contained in:
rubenwardy 2018-08-22 15:19:38 +01:00 committed by GitHub
parent 417ac0fe46
commit 570fd3a206
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -7,25 +7,6 @@ With thanks to Wuzzy, kaeza, and MrIbby.
Majority of awards are back ported from Calinou's old fork in Carbone, under same license. Majority of awards are back ported from Calinou's old fork in Carbone, under same license.
# Introduction # Introduction
@ -189,7 +170,7 @@ end
* awards.register_award(name, def), the def table has the following fields: * awards.register_award(name, def), the def table has the following fields:
* `title` - title of the award (defaults to name) * `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). * `difficulty` - see [Award Difficulty](#award-difficulty).
* `requires` - list of awards that need to be unlocked before this one * `requires` - list of awards that need to be unlocked before this one
is visible. is visible.
@ -201,7 +182,6 @@ end
* `background` - the background image, use default otherwise. * `background` - the background image, use default otherwise.
* `trigger` - trigger definition, see [Builtin Trigger Types](#builtin-trigger-types). * `trigger` - trigger definition, see [Builtin Trigger Types](#builtin-trigger-types).
* `on_unlock(name, def)` - callback on unlock. * `on_unlock(name, def)` - callback on unlock.
* awards.register_trigger(name, def), the def table has the following fields: * awards.register_trigger(name, def), the def table has the following fields:
* `type` - see [Trigger Types](#trigger-types). * `type` - see [Trigger Types](#trigger-types).
* `progress` - used to format progress, defaults to "%1/%2". * `progress` - used to format progress, defaults to "%1/%2".