Merge pull request #217 from DefangLabs/readme-updates

Readme updates
DefangLabs · Oct 3, 2024 · f502921 · f502921
2 parents e67caa9 + 1e05514
commit f502921
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/samples/rails/README.md b/samples/rails/README.md
@@ -38,7 +38,8 @@ Deploy your application to the defang playground by opening up your terminal and
 
 If you want to deploy to your own cloud account, you can use Defang BYOC:
 
-1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
+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`.
+2. Run `defang --provider=aws up` in a terminal that has access to your AWS environment variables.
 
 ---
 

diff --git a/samples/rocket/README.md b/samples/rocket/README.md
@@ -31,8 +31,8 @@ Deploy your application to the defang playground by opening up your terminal and
 
 If you want to deploy to your own cloud account, you can use Defang BYOC:
 
-1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
-2. Run `defang up` in a terminal that has access to your AWS environment variables.
+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`.
+2. Run `defang --provider=aws up` in a terminal that has access to your AWS environment variables.
 
 ---
 

diff --git a/starter-sample/.devcontainer/devcontainer.json b/starter-sample/.devcontainer/devcontainer.json
@@ -5,6 +5,7 @@
   },
   "features": {
     "ghcr.io/defanglabs/devcontainer-feature/defang-cli:1.0.4": {},
-    "ghcr.io/devcontainers/features/docker-in-docker:2": {}
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/aws-cli:1": {}
   }
 }
diff --git a/starter-sample/README.md b/starter-sample/README.md
@@ -7,7 +7,7 @@ This is a sample that shows the rough structure of an actual Defang sample. This
 ## Prerequisites
 
 1. Download [Defang CLI](https://github.com/DefangLabs/defang)
-2. (Optional) If you are using [Defang BYOC](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) authenticated with your AWS account
+2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
 3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
 
 ## Development
@@ -40,8 +40,8 @@ Deploy your application to the defang playground by opening up your terminal and
 
 If you want to deploy to your own cloud account, you can use Defang BYOC:
 
-1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
-2. Run `defang up` in a terminal that has access to your AWS environment variables.
+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`.
+2. Run `defang --provider=aws up` in a terminal that has access to your AWS environment variables.
 
 ---