Skip to content

Commit a86d003

Browse files
committed
refactor: simplify feature descriptions in README and improve clarity in index.html
1 parent 4d5671d commit a86d003

2 files changed

Lines changed: 11 additions & 15 deletions

File tree

Readme.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,12 @@ Run a small BitNet model on local machine with one Docker command, and chat in b
1010

1111
## Features
1212

13-
- Build and start the LLM server with a single command.
14-
- Web interface to chat with the LLM. Start conversation and put follow-up prompts.
15-
- Chat history is stored in browser storage. You get all the chats even if you reload the page or comes back later. It stays in storage unless it is cleared manually.
16-
- A single button to clear all the chats from browser storage.
17-
- LLM remebers the context so you can make follow-up questions it will answer efficiently.
18-
- Responses are streamed from server so you word by word written on page from LLM.
19-
- Runs on any machine with a single docker command.
13+
- Start the LLM server with a single command
14+
- Web UI to chat and continue conversations
15+
- Chat history saved in browser (persists on reload)
16+
- One-click option to clear chats
17+
- Context-aware responses for better follow-ups
18+
- Streaming output (see responses word by word in real-time)
2019

2120
## Working example
2221

docs/index.html

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<script async src="https://www.googletagmanager.com/gtag/js?id=G-3BLBKB5Z8M"></script>
77
<script>
88
window.dataLayer = window.dataLayer || [];
9-
function gtag(){dataLayer.push(arguments);}
9+
function gtag() { dataLayer.push(arguments); }
1010
gtag('js', new Date());
1111

1212
gtag('config', 'G-3BLBKB5Z8M');
@@ -475,11 +475,8 @@ <h1>BitNet-<span>Stack</span></h1>
475475
</header>
476476
<main id="main-content">
477477
<h2>What is BitNet-Stack?</h2>
478-
<p>BitNet-Stack is a small stack for running BitNet inference model on local machine. You use Docker so you do not
479-
install Python or Node on your computer by hand. The container pulls a ready-made model file, starts a server, and
480-
you
481-
open a web page to talk to the model. Code and issues live on <a
482-
href="https://github.com/stackblogger/BitNet-Stack">GitHub</a>.</p>
478+
<p>BitNet-Stack is a small stack to run BitNet inference model on your local machine. It provides an easy to use web
479+
UI to chat with the model.</p>
483480
<p>The model is a compact BitNet GGUF build suited for local use. The server streams answers so you see text appear
484481
as it is written, not only after the full reply is done.</p>
485482

@@ -506,8 +503,8 @@ <h2>Main features</h2>
506503
start.</p>
507504
</div>
508505
</div>
509-
<p>Other useful feature: one <code>docker compose</code> command to build and run, no manual weight downloads on the
510-
host, and a layout that works on laptop or small server.</p>
506+
<p>Other useful feature: one <code>docker compose</code> command to build and run, no manual complex setup required.
507+
</p>
511508

512509
<h2>How it fits together</h2>
513510
<p>Docker runs one service that holds the model and the web server. The static page talks to that service. History

0 commit comments

Comments
 (0)