Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
manu chatterjee committed Apr 12, 2024
1 parent 524c5a3 commit f4343e1
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Create a container element in your HTML where you want the chat interface to app
<div id="chat-container"></div>
```

Initialize XLite Chat in your JavaScript code by providing the container element and a callback function for message events:
Initialize yackbox in your JavaScript code by providing the container element and a callback function for message events:
```javascript
const chat = new yackbox('#chat-container', messageCallback);
//Use the provided methods to interact with the chat control:
Expand All @@ -51,7 +51,7 @@ Yackbox is highly customizable and can be integrated into various web applicatio

## Examples
Included are several examples including:
(./examples/index.html)["examples"]
[Example Code](./examples/index.html)
* UMD and ESM usage in browser
* Multiuser and multiple instance setups
* Using message history and stats
Expand Down
8 changes: 4 additions & 4 deletions examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@
<h2 class="mb-8">yackbox examples</h2>
<p>The following examples can help in getting started with using yackbox</p>

<div class="md-col-5"><a href="./basic-umd">Simple Yackbox from local dist</a><br>Quick example of using yackbox from the CDN with random responses</div><br>
<div class="md-col-5"><a href="./examples/basic-umd/index.html">Simple Yackbox from local dist</a><br>Quick example of using yackbox from the CDN with random responses</div><br>

<div class="md-col-5"><a href="./basic-esm">Simple Yackbox using ESM/ES6 Module syntax</a><br>Quick example of using yackbox by importing it as a module</div><br>
<div class="md-col-5"><a href="./examples/basic-esm/index.html">Simple Yackbox using ESM/ES6 Module syntax</a><br>Quick example of using yackbox by importing it as a module</div><br>

<div class="md-col-5"><a href="./ollama-basic-js/simple_ollama.html">Ollama Basic JS</a><br> A simple demo of how to user yackbox for both completions or streaming results</div><br>
<div class="md-col-5"><a href="./examples/ollama-basic-js/simple_ollama.html">Ollama Basic JS</a><br> A simple demo of how to user yackbox for both completions or streaming results</div><br>

<div class="md-col-5"><a href="./dual-chatrooms/index.html">Dual Chatrooms</a><br>Dual chat rooms on the same screen, each can send messages to each other.</div><br>
<div class="md-col-5"><a href="./examples/dual-chatrooms/index.html">Dual Chatrooms</a><br>Dual chat rooms on the same screen, each can send messages to each other.</div><br>


</div
Expand Down
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h2 id="installation">Installation</h2>
<p>Create a container element in your HTML where you want the chat interface to appear:</p>
<pre><code class="language-html">&lt;div id=&quot;chat-container&quot;&gt;&lt;/div&gt;
</code></pre>
<p>Initialize XLite Chat in your JavaScript code by providing the container element and a callback function for message events:</p>
<p>Initialize yackbox in your JavaScript code by providing the container element and a callback function for message events:</p>
<pre><code class="language-javascript">const chat = new yackbox(&#39;#chat-container&#39;, messageCallback);
//Use the provided methods to interact with the chat control:

Expand All @@ -139,7 +139,7 @@ <h2 id="usage">Usage</h2>
<p>Yackbox is highly customizable and can be integrated into various web applications. You can modify the appearance and behavior of the chat interface by adjusting the CSS styles and JavaScript code according to your requirements.</p>
<h2 id="examples">Examples</h2>
<p>Included are several examples including:
(./examples/index.html)[&quot;examples&quot;]</p>
<a href="./examples/index.html">Example Code</a></p>
<ul>
<li>UMD and ESM usage in browser</li>
<li>Multiuser and multiple instance setups</li>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"chatbox",
"ui",
"chatroom",
"ui",
"history",
"purejs",
"chat",
"llm"
Expand Down

0 comments on commit f4343e1

Please sign in to comment.