moelove commited on
Commit
77aaa1f
Β·
1 Parent(s): 4218b1b

docs: update README to enhance feature descriptions and add chat profile configuration details

Browse files
Files changed (1) hide show
  1. README.md +47 -19
README.md CHANGED
@@ -10,18 +10,33 @@ pinned: false
10
  ---
11
 
12
 
13
- # Thinking Model Client
14
-
15
- A modern React-based chat application that integrates with AI models and displays their thinking process alongside responses.
16
-
17
- ## Features
18
-
19
- - πŸ’¬ Real-time chat interface
20
- - πŸ€– AI model integration
21
- - πŸ“ Multiple conversation management
22
- - βš™οΈ Configurable API settings
23
- - πŸ’Ύ Local storage persistence
24
- - 100% code generated by DeepSeek-R1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
 
26
  ## Getting Started
27
 
@@ -57,11 +72,24 @@ This will concurrently run both the frontend development server and the backend
57
 
58
  ## Configuration
59
 
60
- Configure the application through the settings panel with:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
61
 
62
- - API Endpoint
63
- - Ends with / β†’ /chat/completions will be appended
64
- - Ends with # β†’ # will be removed
65
- - Other cases β†’ /v1/chat/completions will be appended
66
- - API Key
67
- - Model Name (e.g., DeepSeek-R1)
 
10
  ---
11
 
12
 
13
+ # Thinking Model Client πŸ§ πŸ€–
14
+
15
+ [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
16
+ [![Node.js Version](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen)](https://nodejs.org/)
17
+ [![Docker](https://img.shields.io/badge/Docker-Ready-blue)](https://www.docker.com/)
18
+
19
+ A modern React-based chat application that provides a unique interface for interacting with AI models. The application not only displays model responses but also visualizes the thinking process behind each response, giving users insight into how the AI arrives at its conclusions.
20
+
21
+ ## Table of Contents
22
+ - [Features](#features)
23
+ - [Getting Started](#getting-started)
24
+ - [Prerequisites](#prerequisites)
25
+ - [Installation](#installation)
26
+ - [Configuration](#configuration)
27
+
28
+ ## Features ✨
29
+
30
+ - 🧠 **Thinking Process Visualization**: See the step-by-step reasoning behind each AI response with interactive visualizations
31
+ - πŸ”— **Flexible API Integration**: Easily connect to different AI models through configurable API endpoints
32
+ - πŸ’Ύ **Conversation Persistence**: All chats are automatically saved in local storage for continuity
33
+ - 🐳 **Docker Deployment**: Ready for containerized deployment with included Docker configuration
34
+ - βš™οΈ **Customizable Settings**: Adjust API parameters and model configurations through an intuitive settings panel
35
+ - πŸ’¬ **Real-time Chat**: Modern interface with smooth animations and multiple conversation tabs
36
+ - πŸ€– **Multiple Models**: Support for various AI model integrations through a unified interface
37
+ - πŸ› οΈ **Modern Stack**: Built with React and Vite for optimal performance and development experience
38
+ - πŸ§ͺ **Quality Assured**: Comprehensive unit tests ensure reliable functionality
39
+ - πŸ”’ **Local Data Storage**: All data is stored locally for enhanced privacy and security
40
 
41
  ## Getting Started
42
 
 
72
 
73
  ## Configuration
74
 
75
+ The application can be configured through the settings panel, which supports multiple profiles:
76
+
77
+ ### Chat Profiles
78
+
79
+ Each chat profile includes:
80
+ - **Profile Name**: Custom name for the profile
81
+ - **API Endpoint**: The endpoint for the AI model
82
+ - Ends with `/` β†’ `/chat/completions` will be appended
83
+ - Ends with `#` β†’ `#` will be removed
84
+ - Other cases β†’ `/v1/chat/completions` will be appended
85
+ - **API Key**: Your authentication key for the API
86
+ - **Model Name**: The model to use (e.g., DeepSeek-R1)
87
+
88
+ ### Summarization Profile
89
+
90
+ A separate profile for conversation summarization:
91
+ - **API Endpoint**: Endpoint for the summarization service
92
+ - **API Key**: Authentication key for summarization
93
+ - **Model Name**: The model to use for summarization
94
 
95
+ All settings are stored locally for privacy and security. You can manage multiple chat profiles and switch between them as needed.