Skip to content

Commit

Permalink
doc: udpate README
Browse files Browse the repository at this point in the history
  • Loading branch information
jianzs committed Oct 23, 2023
1 parent 81dcdd8 commit 7446fae
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 28 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,27 +123,29 @@ You can learn more about the differences with other project [here](./docs/en/wha

## 🚀 Quick Start (WIP)

1. Install Pluto
### Install Pluto

```shell
npm install pluto
```

2. Prepare AWS access credentials
### Prepare AWS access credentials

If you have multiple profiles, you can specify which profile to use with Pluto through one of the following methods:
If you have already installed and configured the AWS CLI, Pluto will utilize the credentials that you have previously set up. In case you have multiple profiles, you can employ environment variables to choose the desired profile to be activated.

```shell
export AWS_PROFILE="dev" # replace it with your specified profile
```

If you are not using AWS CLI, you need to configure your credentials using the following environment variables.

```shell
export AWS_ACCESS_KEY_ID="AKIAQZDxxxx" # replace it with your AccessKey
export AWS_SECRET_ACCESS_KEY="oE/xxxx" # replace it with your SecretKey
export AWS_PROVIDER_REGION="xx-xxxx-x" # replace it with your AWS Region
export AWS_REGION="xx-xxxx-x" # replace it with your AWS Region
```

3. Deploy your application using Pluto
### Deploy your application using Pluto

```shell
cd apps/cli/examples && pluto deploy
Expand Down
20 changes: 14 additions & 6 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,21 +123,29 @@ Pluto 与其他产品的关键区别在于:它利用程序分析技术直接

## 🚀 快速开始 (WIP)

1. 安装 Pluto
### 安装 Pluto

```shell
npm install pluto
```

2. 准备 AWS 访问凭据
### 准备 AWS 访问凭证

如果你之前已经安装并配置了 AWS CLI, Pluto 将使用你已经配置的凭证信息。如果你有多份配置信息,你可以使用环境变量选用要启用的配置。

```shell
export AWS_PROFILE="dev" # 替换成你指定的配置
```

如果你没有使用 AWS CLI,你需要使用以下环境变量配置你的凭证信息。

```shell
export AWS_ACCESS_KEY_ID="AKIAQZDxxxx" # replace it with your AccessKey
export AWS_SECRET_ACCESS_KEY="oE/xxxx" # replace it with your SecretKey
export AWS_PROVIDER_REGION="xx-xxxx-x" # replace it with your AWS Region
export AWS_ACCESS_KEY_ID="AKIAQZDxxxx" # 替换成你的 AccessKey
export AWS_SECRET_ACCESS_KEY="oE/xxxx" # 替换成你的 SecretKey
export AWS_REGION="xx-xxxx-x" # 替换成你期望部署的 Region
```

3. 使用 Pluto 部署您的应用
### 使用 Pluto 部署您的应用

```shell
cd apps/cli/examples && pluto deploy
Expand Down
16 changes: 0 additions & 16 deletions apps/cli/examples/demo.ts

This file was deleted.

2 changes: 1 addition & 1 deletion apps/cli/template/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ yarn-error.log*
**/dist/

# pluto
**/.pluto/
**/compiled/

0 comments on commit 7446fae

Please sign in to comment.