diff --git a/README.md b/README.md index 7564eb7..35d7cd5 100644 --- a/README.md +++ b/README.md @@ -99,19 +99,14 @@ paka cluster down -f cluster.yaml ``` ## Contributing +- code changes +- `make check-all` - Open a PR -- Format and lint code with `make lint` -- Run tests with `make test` ## Dependencies -- docker daemon -- pulumi cli (https://www.pulumi.com/docs/install/) -- aws cli and credentials for the AWS deployment +- docker daemon and CLI +- credentials for the AWS cloud ```bash -# Make sure aws credentials and cli are set up. Your aws credentials should have access to the following services: -# - S3 -# - ECR -# - EKS -# - EC2 -aws configure +# Ensure your AWS credentials are correctly configured. Execute the command below and verify that the keys `aws_access_key_id` and `aws_secret_access_key` are present. +cat ~/.aws/credentials ``` diff --git a/examples/invoice_extraction/README.md b/examples/invoice_extraction/README.md index f2a5235..711e4fb 100644 --- a/examples/invoice_extraction/README.md +++ b/examples/invoice_extraction/README.md @@ -9,15 +9,8 @@ Follow the steps below to run the example: ```bash pip install paka - # Ensure AWS credentials and CLI are set up. Your AWS credentials should have access to the following services: - # - S3 - # - ECR - # - EKS - # - EC2 - aws configure - - # Install pulumi CLI and verify it is working (https://www.pulumi.com/docs/install/) - pulumi version + cat ~/.aws/credentials + # Make sure you have the following keys aws_access_key_id and aws_secret_access_key ``` 2. **Ensure the Docker daemon is running:** diff --git a/examples/website_rag/README.md b/examples/website_rag/README.md index 21c13bb..dd1f15b 100644 --- a/examples/website_rag/README.md +++ b/examples/website_rag/README.md @@ -9,15 +9,8 @@ To run the example, first install the necessary dependencies: ```bash pip install paka -# Make sure aws credentials and cli are set up. Your aws credentials should have access to the following services: -# - S3 -# - ECR -# - EKS -# - EC2 -aws configure - -# Install pulumi CLI and verify it is working (https://www.pulumi.com/docs/install/) -pulumi version +# Ensure your AWS credentials are correctly configured. Execute the command below and verify that the keys `aws_access_key_id` and `aws_secret_access_key` are present. +cat ~/.aws/credentials ``` ### Make sure docker daemon is running