Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zhu-xiaowei committed Dec 30, 2024
1 parent 156da8c commit 9e3702c
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 12 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ macOS platforms.
- Upload large videos (1080p/4K) beyond 8MB with auto compression
- Support using natural language to make Nova Canvas generate images, remove backgrounds, replace backgrounds, and
create images in similar styles.
- Support LaTeX formula rendering for Amazon Nova.
- Support LaTeX formula rendering (inline and display modes) 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.
We redesigned the UI with optimized font sizes and line spacing for a more elegant and clean presentation. The image
below demonstrates SwiftChat rich markdown content support (Paragraph, Code Blocks, Tables, LaTeX and more)

![](assets/markdown.png)

Expand Down Expand Up @@ -167,11 +167,10 @@ We feature streamlined chat History, Settings pages, and intuitive Usage statist
- [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.
We have optimized the layout for landscape mode. As shown below, you can comfortably view table contents in landscape
orientation.

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

## What Makes SwiftChat Really "Swift"?

Expand Down
10 changes: 5 additions & 5 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,14 @@ macOS 等多个平台。
- 支持直接在安卓和 iOS 设备上录制最长 30 秒的视频供 Nova 分析
- 支持自动压缩上传超过 8MB 的高清视频(1080p/4K)
- 支持通过自然语言让 Nova Canvas 生成图片,去除背景,替换背景,以及生成类似风格的图片
- 支持 Amazon Nova 系列渲染 LaTeX 公式
- 支持 Amazon Nova 系列 LaTeX 公式渲染(行内混排和单独显示模式)

下图展示了 SwiftChat 支持丰富的 Markdown 内容渲染,其中我们从头设计了 UI,例如字号,行间距。使其展示更加美观简洁。
其中我们从新设计了 UI,例如字号行间距等,使其展示更加美观简洁。下图展示了 SwiftChat 支持丰富的 Markdown 内容渲染(段落、代码块、表格、LaTeX
公式等)。

![](assets/markdown.png)

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

## 架构

Expand Down Expand Up @@ -156,9 +157,8 @@ macOS 等多个平台。
- [x] 在设置中查看详细的 token 使用情况和图片生成数量
- [x] 应用内升级提示(Android 和 macOS)

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

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

Expand Down
Binary file modified 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 removed assets/landscape_code.png
Binary file not shown.
Binary file removed assets/landscape_code_zh.png
Binary file not shown.
Binary file modified 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.
2 changes: 1 addition & 1 deletion server/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## SwiftChat Backend API

The SwiftChat backend API is implemented using Python language and the FastAPI framework. It is packaged as a Docker image using [aws-lambda-adapter](https://github.com/awslabs/aws-lambda-web-adapter) and deployed to both AWS App Runner and AWS Lambda for execution.
The SwiftChat backend API is implemented using Python language and the FastAPI framework. It is packaged as a Docker image using [aws-lambda-adapter](https://github.com/awslabs/aws-lambda-web-adapter) and deployed to AWS App Runner or AWS Lambda for execution.

## API Reference

Expand Down

0 comments on commit 9e3702c

Please sign in to comment.