From 90bf9b061ad58fdf4c62d2d064cf7826a466f9b6 Mon Sep 17 00:00:00 2001
From: Wuzzy <almikes@aol.com>
Date: Thu, 1 Sep 2016 16:05:42 +0200
Subject: Add notification sound

License of default sound: CC-0
Source: https://www.freesound.org/people/Kastenfrosch/sounds/162482/
---
 readme.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index f2f2683..db5fc41 100644
--- a/readme.md
+++ b/readme.md
@@ -13,7 +13,8 @@ old fork in Carbone, under same license.
 * awards.register_achievement(name, def)
 	* name
 	* desciption
-	* sound [optional]
+	* sound [optional] - set a custom sound (SimpleSoundSpec) or `false` to play no sound.
+          If not specified, a default sound is played
 	* image [optional] - texture name, eg: award_one.png
 	* background [optional] - texture name, eg: award_one.png
 	* trigger [optional] [table]
-- 
cgit v1.2.3