diff --git a/modules/default/alert/README.md b/modules/default/alert/README.md index 0451104c..4eb1428a 100644 --- a/modules/default/alert/README.md +++ b/modules/default/alert/README.md @@ -9,36 +9,76 @@ modules: [ { module: 'alert', config: { - // style type: growl|attached|bar - style: "growl", - // effects for the specified style: - // for growl style: scale|slide|genie|jelly - // for attached style: flip|bouncyflip - // for bar style: slidetop|exploader - effect: "slide", - //time a notification is displayed - display_time: 3500, - //shown at startup - welcome_message: "Welcome, start was successfull!" + // The config property is optional. + // See 'Configuration options' for more information. } } ] ``` -##Developer notes + +## Configuration options + +The following properties can be configured: + + +
Option | +Description | +
---|---|
style |
+ The style of the notifications. + Possible values: growl , attached and bar
+ Default value: growl
+ |
+
effect |
+ The animation effect of the notification style to use. + Possible values for growl style: scale , slide , genie and jelly
+ Possible values for attached style: flip and bouncyflip
+ Possible values for bar style: slidetop and exploader
+ Default value: slide
+ |
+
display_time |
+ Time a notification is displayed. + Possible values: any int
+ Default value: 3500
+ |
+
welcome_message |
+ Message shown at startup. + Possible values: any string
+ Default value: Welcome, start was successfull!
+ |
+