Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README with details on importing using CDN #26

Merged
merged 2 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down Expand Up @@ -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
5 changes: 5 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down