Merge pull request #26 from tarkalabs/shamil/update-readme-with-cdn-d…

…etails Updated README with details on importing using CDN
tarkalabs · Feb 7, 2024 · 1b0f518 · 1b0f518
2 parents 91cf9b0 + 4364335
commit 1b0f518
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,17 @@
 
 Tarka Chat UI is a plug and play javascript library to integrate a chat assistant to your website in one line
 
-## How to use it
 
-Incude the following script in your html
+## Usage
 
-`<script src="https://tarkalabs.github.io/tarka-chat/dist/tarka-chat.umd.js"></script>`
+1. Incude the following script (hosted in CDN) in your html
 
-Initialise the global `TarkaChat` component with options in any script tag
+ ```
+ <script src="https://d1fmfone96g0x2.cloudfront.net/tarka-chat-2.0.2.umd.js"></script>
+ ```
+
+
+2. Initialise the global `TarkaChat` component with options in any script tag
 
 ```
 TarkaChat.init({
@@ -44,4 +48,15 @@ where,
 - **selectorId** the DOM element selector (id) inside which the bot will be rendered
 - **submitHandler** this function will be called whenever a user types a message in the bot and submits
 
-Demo : https://tarkalabs.github.io/tarka-chat/demo/
+
+## Demo
+
+Demo is deployed from the application code in `demo/` folder.
+Link: https://tarkalabs.github.io/tarka-chat/demo/
+
+## Old versions
+
+v1.1 : https://d1fmfone96g0x2.cloudfront.net/tarka-chat-1.1.umd.js
+v1.0 : https://d1fmfone96g0x2.cloudfront.net/tarka-chat-1.1.umd.js
+
+Check [release notes](RELEASE.md) for details
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,5 @@
+# v1.1
+- Fixed the issue #18 where the chat window does not render correctly in mobile view
+
+# v1.0
+Initial version
diff --git a/demo/index.html b/demo/index.html
@@ -13,7 +13,7 @@
     </style>
 
     <!-- Include this javscript -->
-    <script src="https://tarkalabs.github.io/tarka-chat/dist/tarka-chat.umd.js"></script>
+    <script src="https://d1fmfone96g0x2.cloudfront.net/tarka-chat-2.0.2.umd.js"></script>
   </head>
   <body>
     <div class="container">