Skip to content

Commit a4852bd

Browse files
committed
docs: simplify readme
1 parent db3587c commit a4852bd

File tree

2 files changed

+28
-26
lines changed

2 files changed

+28
-26
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,11 @@ macOS platforms.
2424

2525
![](/assets/architecture.png)
2626

27-
By default, we use AWS App Runner, which is commonly used to host Python FastAPI servers, offering high performance,
27+
By default, we use **AWS App Runner**, which is commonly used to host Python FastAPI servers, offering high performance,
2828
scalability and low latency.
2929

30-
Alternatively, we provide the option to replace App Runner with AWS Lambda using Function URL for a more cost-effective
30+
Alternatively, we provide the option to replace App Runner with **AWS Lambda** using Function URL for a more
31+
cost-effective
3132
solution, as shown in
3233
this [example](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examples/fastapi-response-streaming).
3334

@@ -46,25 +47,28 @@ enable your models.
4647

4748
### Step 1: Set up your API Key
4849

49-
1. Right-click [Parameter Store](https://console.aws.amazon.com/systems-manager/parameters/) to open your AWS Console in
50-
new window.
50+
1. Sign in to your AWS console and
51+
right-click [Parameter Store](https://console.aws.amazon.com/systems-manager/parameters/) to open it in a new tab.
5152
2. Check whether you are in the [supported region](#supported-region), then click on the **Create parameter** button.
52-
3. Fill the parameters below, leaving other options as default.
53-
* **Name**: Enter a name for your parameter (e.g., "SwiftChatAPIKey", this is `ApiKeyParam` you will fill
54-
in [Step2](#step-2-deploy-stack-and-get-your-api-url)).
55-
* **Type**: Select `SecureString`.
56-
* **Value**: Any string without spaces (This is the `API Key` you'll need to configure your App
57-
in [Step 3](#step-3-download-the-app-and-setup-with-api-url-and-api-key)).
53+
3. Fill in the parameters below, leaving other options as default:
54+
55+
* **Name**: Enter a parameter name (e.g., "SwiftChatAPIKey", will be used as `ApiKeyParam` in Step 2).
56+
57+
* **Type**: Select `SecureString`
58+
59+
* **Value**: Enter any string without spaces.(this will be your `API Key` in Step 3)
60+
5861
4. Click **Create parameter**.
5962

6063
### Step 2: Deploy stack and get your API URL
6164

62-
1. Click the following button to launch the CloudFormation Stack in the same region with your API Key just created.
63-
- App Runner
65+
1. Click one of the following buttons to launch the CloudFormation Stack in the same region where your API Key was
66+
created.
67+
- **App Runner**
6468

6569
[![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatAppRunner.template)
6670

67-
- Lambda (Note: Make sure your AWS account allows public Lambda Function URL)
71+
- **Lambda** (Note: For AWS customer use only)
6872

6973
[![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatLambda&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatLambda.template)
7074

@@ -124,7 +128,7 @@ Congratulations 🎉 Your SwiftChat App is ready to use!
124128

125129
### Image Features
126130

127-
- [x] Support image generation with Chinese prompts
131+
- [x] Support image generation with Chinese prompts(Make sure `Claude 3 Haiku` is enabled in your selected region)
128132
- [x] View and zoom generated images
129133
- [x] Long press images to save or share
130134
- [x] Automatic image compression to optimize token usage
@@ -173,7 +177,7 @@ Congratulations 🎉 Your SwiftChat App is ready to use!
173177
- No data collection
174178
- Privacy-first approach
175179

176-
## App Build and development
180+
## App Build and Development
177181

178182
First, clone this repository. All app code is located in the `react-native` folder. Before proceeding, execute the
179183
following command to download dependencies.

README_CN.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ macOS 等多个平台。
2323

2424
![](/assets/architecture.png)
2525

26-
默认情况下,我们使用 AWS App Runner(通常用于托管 Python FastAPI 服务器),提供高性能、可扩展性和低延迟。
26+
默认情况下,我们使用 **AWS App Runner**(通常用于托管 Python FastAPI 服务器),提供高性能、可扩展性和低延迟。
2727

28-
另外,我们提供使用 AWS Lambda 的 Function URL 替代 App Runner
28+
另外,我们提供使用 **AWS Lambda** 的 Function URL 替代 App Runner
2929
的选项,以获得更具成本效益的解决方案,如 [示例](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examples/fastapi-response-streaming)
3030
所示。
3131

@@ -44,24 +44,22 @@ macOS 等多个平台。
4444

4545
### 第1步: 设置API Key
4646

47-
1. 右键点击 [Parameter Store](https://console.aws.amazon.com/systems-manager/parameters/) 在新窗口中打开 AWS 控制台
47+
1. 登录您的 AWS 控制台并右键点击 [Parameter Store](https://console.aws.amazon.com/systems-manager/parameters/) 在新窗口中打开。
4848
2. 检查您是否在 [支持的区域](#支持的区域),然后点击 **创建参数** 按钮。
4949
3. 完成以下参数填写,其他选项保持默认:
50-
* **名称**:为您的参数输入描述性名称(例如 "SwiftChatAPIKey",这是您将在 [第2步](#第2步-部署堆栈并获取api-url)
51-
中填写的`ApiKeyParam`)。
50+
* **名称**:输入参数名称(例如 "SwiftChatAPIKey",该名称将在步骤2中用作 `ApiKeyParam`)。
5251
* **类型**:选择 `SecureString`
53-
* ****:任何不含空格的字符串(这是您需要在 [第3步](#第3步-下载应用并设置-api-url-和-api-key) 中配置 App
54-
`API Key`)。
52+
* ****:任何不含空格的字符串(该值将在步骤 3 的应用设置中作为 `API Key` 使用)。
5553
4. 点击 **创建参数**
5654

5755
### 第2步: 部署堆栈并获取API URL
5856

59-
1. 点击以下按钮在与刚才创建的 API Key 相同的区域启动 CloudFormation 堆栈。
60-
- App Runner
57+
1. 点击以下按钮中的一个,在 API Key 所在区域启动 CloudFormation 堆栈。
58+
- **App Runner**
6159

6260
[![启动堆栈](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatAppRunner.template)
6361

64-
- Lambda (提示:请确保你的 AWS 账户允许公开 Lambda Function URL)
62+
- **Lambda** (注意:仅供 AWS 客户使用)
6563

6664
[![启动堆栈](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatLambda&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatLambda.template)
6765

@@ -121,7 +119,7 @@ macOS 等多个平台。
121119

122120
### 图片功能
123121

124-
- [x] 支持使用中文生成图片
122+
- [x] 支持使用中文生成图片(确保在所选区域启用了`Claude 3 Haiku`
125123
- [x] 支持点击查看和缩放生成的图片
126124
- [x] 长按图片可保存或分享
127125
- [x] 自动压缩上传图片以优化 token 使用

0 commit comments

Comments
 (0)