Mercurial > prosody-modules

diff mod_candy/README.markdown @ 2450:36ffe9d11132

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_candy: Add config option for a list of rooms to join
author Kim Alvefur <zash@zash.se>
date Fri, 20 Jan 2017 01:24:32 +0100
parents 52dd2a51dac8
children 56bab95e57f0
line wrap: on
line diff
--- a/mod_candy/README.markdown	Fri Jan 20 01:09:36 2017 +0100
+++ b/mod_candy/README.markdown	Fri Jan 20 01:24:32 2017 +0100
@@ -30,8 +30,10 @@
 After the module has been loaded, Candy will by default be reachable
 from `http://example.com:5280/candy/`
 
-It may be helpful to also enable [mod\_default\_bookmarks] so that Candy
-users always have some room(s) to join, or it will show an empty screen.
+You can configure what rooms to join using either `candy_rooms` (an
+array) or [mod\_default\_bookmarks]. By default, Candy will attempt to
+join rooms that the current user has bookmarked. If there are no rooms
+to join, then Candy will show an emtpy screen.
 
 Compatibility
 =============