@rocket.chat/livechat 1.9.3 → 1.10.0

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.10.0 - 2021-11-22
+[NEW] Audio and Video calling in Livechat using WebRTC (#646)
+[FIX] LoadConfig after registering guest (#640)
+[FIX] Body styles getting overridden (#660)
+
+## 1.9.6 - 2021-10-20
+[FIX] 'Hide agent info' not working on system message (#651)
+[FIX] Issues on Custom Livechat messages (#648)
+
+## 1.9.5 - 2021-09-14
+[IMPROVE] Readme enhancements (#557)
+[IMPROVE] Swedish Translations (#573)
+[FIX] Escaping HTML on paste/drop Text (#471)
+[IMPROVE] Spanish translations (#370)
+[IMPROVE] Russian translations (#644)
+[IMPROVE] Add cookie to identify widget calls (#645)
+
+## 1.9.4 - 2021-08-19
+[FIX] Iframe overlay (#631)
+[IMPROVE] German informal translation (#622) 
+[FIX] Translation error on department (#632)
+[IMPROVE] Open links in another tab on Livechat widget (#610) 
+[IMPROVE] Dutch Translations (#601) 
 
 ## 1.9.3 - 2021-04-21
 [FIX] sound notification on/off (#567)

package/README.md

@@ -2,13 +2,68 @@
 [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/RocketChat/Rocket.Chat.Livechat.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RocketChat/Rocket.Chat.Livechat/context:javascript)
 [![Total alerts](https://img.shields.io/lgtm/alerts/g/RocketChat/Rocket.Chat.Livechat.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RocketChat/Rocket.Chat.Livechat/alerts/)
 [![Storybook](https://cdn.jsdelivr.net/gh/storybooks/brand@master/badge/badge-storybook.svg)](https://rocketchat.github.io/Rocket.Chat.Livechat)
-## CLI Commands
+
+Currently, it's very common to find chat pop-ups when you're browsing websites.
+
+Those widgets, at Rocket.Chat, are called **LiveChat**.
+
+**LiveChat** is a small and lightweight application designed to provide B2C (Business-to-customer) communication between Agents and website visitors and is developed with [Preact](https://preactjs.com).
+
+## Running a development environment
+
+With your **Rocket.chat** running locally at http://localhost:3000
+<br />
+
+1. Install all node dependencies.
+``` bash
+yarn
+```
+
+2. Build preact application to `/build` folder
+``` bash
+yarn dev
+```
+
+3. In another terminal, run webpack with hot reload at http://localhost:8080
+``` bash
+yarn start
+```
+
+4. Open this file below in your browser
+``` bash
+widget-demo.html
+```
+
+*OBS: For a better performance, you can run this `widget-demo.html` on a [http server](https://github.com/http-party/http-server).*
+
+## Different host
+
+To select a different host on your local widget, check this configuration at `/src/api.js` file.
+
+``` javascript
+const host = window.SERVER_URL
+	|| queryString.parse(window.location.search).serverUrl
+	|| (process.env.NODE_ENV === 'development' ? 'http://localhost:3000' : null);
+```
+
+Here, you can change to your new configuration.
+
+``` javascript
+const host = window.SERVER_URL
+	|| queryString.parse(window.location.search).serverUrl
+	|| (process.env.NODE_ENV === 'development' ? 'https://your.rocketserver.com' : null);
+```
+
+## Available CLI Commands
 
 ``` bash
 # install dependencies
 yarn
 
 # serve with hot reload at localhost:8080
+yarn start
+
+# build preact application to "build" folder
 yarn dev
 
 # build for production with minification