Skip to content

Commit 5fddab0

Browse files
authored
Merge pull request #225 from DefangLabs/linda-starter-compose-up
Added larger code block in starter sample readme
2 parents 931c10d + 517d096 commit 5fddab0

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

starter-sample/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ docker compose up --build
2424

2525
For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration). Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.
2626

27-
### `API_KEY` #REMOVE_ME_AFTER_EDITING
27+
### `API_KEY` #REMOVE_ME_AFTER_EDITING
2828
An explanation of what the env var (`API_KEY`) is, etc.
2929

3030
## Deployment
@@ -34,14 +34,20 @@ An explanation of what the env var (`API_KEY`) is, etc.
3434
3535
### Defang Playground
3636

37-
Deploy your application to the defang playground by opening up your terminal and typing `defang compose up`.
37+
Deploy your application to the Defang Playground by opening up your terminal and typing:
38+
```bash
39+
defang compose up
40+
```
3841

3942
### BYOC (AWS)
4043

4144
If you want to deploy to your own cloud account, you can use Defang BYOC:
4245

4346
1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and check that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
44-
2. Run `defang --provider=aws up` in a terminal that has access to your AWS environment variables.
47+
2. Run in a terminal that has access to your AWS environment variables:
48+
```bash
49+
defang --provider=aws compose up
50+
```
4551

4652
---
4753

0 commit comments

Comments
 (0)