Skip to content

Commit 7c9e83c

Browse files
authored
Update README.md
I added the content to readme file
1 parent 08e4f03 commit 7c9e83c

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,48 @@
11
# OpenAI-HTML-Client
22
This is a simple, local-only interface for interacting with the OpenAI API. It's a single HTML file that you can run directly in your web browser, I made it becouse at the uni they gave me a key to interact with the OpenAI API but sometimes I just want to use the ChatGPT Premium capabilities in a simple web-interface. Feel free to contribute.
3+
4+
***
5+
6+
# Local ChatGPT UI
7+
8+
This is a simple, local-only interface for interacting with the OpenAI API. It's a single HTML file that you can run directly in your web browser.
9+
10+
The main goal is to provide a straightforward chat experience without needing to install anything or run a web server. All your data, including your API key and chat history, is stored on your own computer in the browser's local storage.
11+
12+
## How to Use
13+
14+
It's designed to be as easy as possible to get started:
15+
16+
1. Download the project files (click `Code` > `Download ZIP`).
17+
2. Unzip the folder.
18+
3. Double-click the `index.html` file to open it in your browser.
19+
20+
That's it. Once it's open, you just need to enter your OpenAI API key, and it will load the available models.
21+
22+
## Functionality
23+
24+
Here is what the tool can do:
25+
26+
* **Chat with the OpenAI API:** The main function is to send and receive messages.
27+
* **Save Chat Sessions:** Your conversations are automatically saved and grouped into different sessions that you can switch between.
28+
* **Edit Session Names:** You can rename your chat sessions.
29+
* **Import/Export:** You can export all your chats to a single JSON file or import them back in.
30+
* **File/Image Uploads:** Allows you to attach files and images to your prompts (for models that support it, like GPT-4o).
31+
* **Streaming Responses:** Shows the AI's response as it's being generated.
32+
* **Model Selection:** Lets you pick from the models available with your API key.
33+
34+
## Beta Features Disclaimer
35+
36+
Some of the more complex rendering features were added for convenience but are still in a **beta stage**. They are a terrible built and may have bugs or fail to render correctly in some cases.
37+
38+
* **Markdown Detection:** Basic Markdown like headers and bold text should work, but it can be unreliable with more complex formatting.
39+
* **Code Block Detection:** It tries to find and highlight code blocks, but this might not always work as expected, especially with nested or oddly formatted code.
40+
* **LaTeX Rendering:** Support for math equations is experimental and may not render all expressions correctly.
41+
42+
These features are included as-is. Improvements may be made in the future.
43+
44+
## Contributing
45+
46+
If you want to fix something or add a feature, feel free to do so. Since there is no build process, you can edit the `.js` and `.css` files directly and just refresh the page in your browser to see the changes.
47+
48+
It should be responsive to a acceptable level

0 commit comments

Comments
 (0)