Skip to content

Commit

Permalink
docs: update readme add images
Browse files Browse the repository at this point in the history
  • Loading branch information
zhu-xiaowei committed Dec 29, 2024
1 parent 7a2ef79 commit 4547d10
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ macOS platforms.
create images in similar styles.
- Support LaTeX formula rendering for Amazon Nova.

The image below demonstrates SwiftChat rich markdown content support. We redesigned the UI with optimized font sizes and
line spacing for a more elegant and clean presentation.

![](assets/markdown.png)

All of these features are seamlessly displayed across all supported platforms with native UI.

## Architecture

![](/assets/architecture.png)
Expand Down Expand Up @@ -125,6 +132,10 @@ Congratulations 🎉 Your SwiftChat App is ready to use!

## Detailed Features

We feature streamlined chat History, Settings pages, and intuitive Usage statistics:

![](assets/history_settings.png)

### Message Handling

- [x] Text copy support:
Expand Down Expand Up @@ -156,6 +167,12 @@ Congratulations 🎉 Your SwiftChat App is ready to use!
- [x] Check detailed token usage and image generation count in Settings
- [x] In-app upgrade notifications (Android & macOS)

We have optimized the layout for landscape mode. As shown below, you can comfortably view table and code contents in
landscape orientation.

![](assets/landscape.png)
![](assets/landscape_code.png)

## What Makes SwiftChat Really "Swift"?

🚀 **Fast Launch Speed**
Expand Down
14 changes: 14 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ macOS 等多个平台。
- 支持通过自然语言让 Nova Canvas 生成图片,去除背景,替换背景,以及生成类似风格的图片
- 支持 Amazon Nova 系列渲染 LaTeX 公式

下图展示了 SwiftChat 支持丰富的 Markdown 内容渲染,其中我们从头设计了 UI,例如字号,行间距。使其展示更加美观简洁。

![](assets/markdown.png)

你所看到的这些内容都可以在所有支持的平台上以原生 UI 的形式很好的呈现。

## 架构

![](/assets/architecture.png)
Expand Down Expand Up @@ -114,6 +120,10 @@ macOS 等多个平台。

## 详细功能

我们拥有简洁的历史记录,设置页面,和直观的 Usage 统计页面:

![](assets/history_settings_zh.png)

### 消息处理

- [x] 文本复制支持:
Expand Down Expand Up @@ -146,6 +156,10 @@ macOS 等多个平台。
- [x] 在设置中查看详细的 token 使用情况和图片生成数量
- [x] 应用内升级提示(Android 和 macOS)

我们针对横屏做了相应优化,下图展示了通过横屏模式您可以很好的阅读代码及表格内容。
![](assets/landscape_zh.png)
![](assets/landscape_code_zh.png)

## 是什么让 SwiftChat 如此"迅速"?

🚀 **快速启动速度**
Expand Down
Binary file added assets/history_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/history_settings_zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/landscape.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/landscape_code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/landscape_code_zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/landscape_zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/markdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/markdown_zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4547d10

Please sign in to comment.