Merge pull request #1 from Cognigy/feature/74036-edit-v3-readme

Edit README of the new v3 repo

Author: sushmi21

README.md

@@ -1,3 +1,39 @@
-# Cognigy Webchat Widget (v3)
+# Cognigy Webchat (v3)
 
-The `v3` branch contains a work-in-progress version of our next Webchat Widget and must not be used in production. We will announce our new Webchat Widget properly once it is ready.
+Webchat v3 is a significant upgrade from the previous Webchat 2 versions, featuring enhanced user interface, improved customization options, and a host of [new features](https://docs.cognigy.com/webchat/v3/features/#webchat-3-key-features) designed to provide a better user experience.
+
+## Documentation
+
+To get started using this newer version of Webchat on your website, you can refer to the [Documentation section](./docs/README.md) in this repository. For additional information, please consult the [Getting Started with Webchat v3](https://docs.cognigy.com/webchat/getting-started/) guide in our product documentation.
+
+Customizing your Webchat endpoint has been made easy with Webchat v3, as it offers a lot of new settings. Here you can find the [list of endpoint settings](./docs/embedding.md/#endpoint-settings). information on further styling customization can be found in the [guide on applying custom CSS to the Webchat](./docs/css-customization.md).
+
+## Building your Webchat
+
+You need an installed version of `Node.js` to build your Webchat. Clone this repository, then run `npm i` and `npm run bundle` within the root folder to install dependencies and create bundle files in `dist/`.
+
+## Development
+
+For development purposes, you can utilize `npm run dev`. This command spawns an HTTP server on port 8080, showcasing the current form of the webchat directly from the source code. It automatically reloads upon updating source files, simplifying the development process.
+It automatically reloads when you make changes, streamlining the development process.
+
+## Compatibility Builds
+
+The `npm run bundle` command generates bundle files for the Webchat itself and basic Webchat plugins. Additionally, it produces a second version of each bundle ending in `.legacy.js`. These builds maintain the same feature set as the regular ones but are converted into an older JavaScript standard, enhancing compatibility for older browsers that lack support for modern JavaScript features, such as Internet Explorer 11. When you run the command `npm run bundle`, it creates bundle files for the Webchat along with some basic Webchat plugins. This command also produces a second version of each bundle, which has `.legacy.js` at the end of its name. These builds have the same features as the regular ones but are converted into an older JavaScript standard. This enhances compatibility for older browsers that don't support modern JavaScript features, such as Internet Explorer 11.
+
+## Migration Guide
+
+If you are already using Webchat 2 and want to migrate to Webchat v3, please follow the [migration guide](https://docs.cognigy.com/webchat/migration/) here.
+
+## DEPRECATION WARNING FOR WEBCHAT v2
+
+With the release of our Webchat v3, we are also announcing the deprecation of older versions of [Webchat (v2.X)](https://github.com/Cognigy/WebchatWidget).
+
+**End of Support: 31st January 2026**
+
+### What This Means for You:
+Effective immediately, there will be
+- No Further Feature Updates: We will no longer release feature updates for the deprecated Webchat versions.
+- No Bug Fixes: Issues reported in the deprecated versions will not be addressed.
+- Limited Support: Customer support for the deprecated versions will be significantly reduced and eventually unavailable after the end of support date.
+- Security Fixes: We will continue to provide security fixes until the end of the support date.