From 8a216a6d8c88631e894e6a482a59754f6f178512 Mon Sep 17 00:00:00 2001 From: Chtixof Date: Sat, 11 Apr 2015 00:53:40 +0200 Subject: [PATCH] README.md updated --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a11e46f..f9cebf6 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,10 @@ It is based on [wojtek77/chat](https://github.com/wojtek77/chat), itself based o ## Features -- No need for users to register. Just need the web address. +- Simple web chat: only requires a browser ; no XMPP application +- No need for users to register. Just need the web address. But optional authorisation control. - On connection, the page is feeded with the 50 last messages of the day -- Args are in the URL as *get* arguments, so that you can share the URL or make it a favorite +- Args are in the URL as *get* arguments, so that you can share the URL or make it a favorite to avoid filling a form. Example : `https://yourdomain.org/minchat/?room=Living&name=John` - Optionaly multi room @@ -18,7 +19,7 @@ Or on ssh : `sudo yunohost app install https://github.com/chtixof/minchat_ynh` ### Otherwise Download, unzip and just copy the content of the `sources` folder to any folder of your web site. ## Setup -On the application folder of your site, edit the file `conf/setup.ini`. The interesting parameter is `auth` that indicates which user is authorized to which room. +The setup is optional. If you leave it as is, there is a single unnamed room, opened to all users. If you want to customize the access control, edit the file `conf/setup.ini`. The interesting parameter is `auth` that indicates which user is authorized to which room. In this example `auth = John:Game,Mary:Game,John:Family,Tim:Family,admin:,:Public`, - John can access the Game room, the Family room and the Public room @@ -27,7 +28,5 @@ In this example `auth = John:Game,Mary:Game,John:Family,Tim:Family,admin:,:Publi - admin can access all rooms - other users can only acccess the Public room -If `auth` is not set (default), there is a single unnamed room, opened to all users. - ## Screen shot ![screenshot](https://raw.githubusercontent.com/chtixof/databank/master/minchat_ynh/minchat_ynh_screenshot01.gif) \ No newline at end of file